npm i -g @instafy/cli

Instafy CLI (Preview)

Run Instafy projects locally and connect them back to Instafy Studio — from any terminal.

Quickstart

0. Log in once: instafy login
- Opens a Studio URL; the CLI continues automatically after you sign in.
- Also enables Git auth (credential helper) for Instafy Git Service. Disable with instafy login --no-git-setup.
- Multiple accounts: instafy login --profile work (then bind folders with instafy project init --profile work or instafy project profile work).
- Optional: set defaults with instafy config set controller-url / instafy config set studio-url
1. Link a folder to a project:
- VS Code: install the Instafy extension and run Instafy: Link Workspace to Project, or
- Terminal: instafy project init
2. Start the runtime: instafy runtime start
3. Check status / stop:
- instafy runtime status
- instafy runtime stop

Common commands

- instafy runtime start — start a local runtime (agent + origin).
- instafy runtime status — show health of the last started runtime.
- instafy runtime stop — stop the last started runtime.
- instafy git — run git commands against an Instafy canonical checkout (.instafy/.git) when present.
- instafy tunnel start — start a detached tunnel for a local port.
- instafy tunnel list — list local tunnels started by the CLI.
- instafy tunnel logs --follow — tail tunnel logs.
- instafy tunnel stop — stop + revoke a tunnel.
- instafy api get — query controller endpoints (conversations, messages, runs, etc).

Run instafy --help for the full command list and options.

Docs

- CLI reference & troubleshooting: https://github.com/instafy-dev/instafy/blob/main/docs/CLI.md