Documentation

Touch Pie setup guide

Everything needed to install, update, restore, and understand the Touch Pie package.

Install

npm install -g @talex-touch/touch-pie

Global install creates pie and touch-pie command shims, saves a restore point, and adds the shim directory to user PATH. Open a new terminal, then run:

touch-pie

The setup command installs the Pi package, safely merges settings, installs a default AGENTS.md only when missing, and prints a first-run change notice.

Update

pie update

This updates the global npm package and re-syncs Pi package, settings, and shims.

Uninstall / restore

touch-pie uninstall
npm uninstall -g @talex-touch/touch-pie

The uninstall command restores from the saved manifest before removing the global npm package.

What changes?

settings.json

Sets quietStartup=true and removes legacy conflicting package entries.

AGENTS.md

Installs the safe template only when missing. Existing files are never overwritten.

PATH

Adds the Touch Pie shim directory to user PATH during global install.

Pi core

Unchanged unless --apply-core-patch is explicitly used.

Safety model

• No API keys, model provider config, tokens, chat history, cache, or logs are packaged.
• Backups are allowlisted and written under ~/.pi/agent/touch-pie-backups.
• touch-pie-state.json stores only restore metadata and pending notice text.

Troubleshooting

touch-pie is not recognized on Windows

Open a new terminal first. If it still fails, run:

npm exec --package @talex-touch/touch-pie -- touch-pie --update-path

Do not run npx pie

npx pie resolves a different npm package name and can launch the wrong Pi version. Use the installed pie command.