Docs

CLI

Sign in, scaffold, run, and deploy snippets from your terminal.

The QuikRun CLI is a thin client over the QuikRun API. Install it globally, or run it on demand with npx. Requires Node.js 20 or newer.

npm install -g quikrun     # then: quikrun <command>
# or, no install:
npx quikrun <command>      # prefix every command with npx

Sign in

quikrun login opens your browser, you click Authorize, and the CLI captures the token automatically. It is saved to ~/.quikrun/config.json.

quikrun login                       # browser sign-in
quikrun login quik_xxxxxxxx         # headless: pass a token
export QUIKRUN_TOKEN=quik_xxxxxxxx  # or set it in the environment

Commands

quikrun login [token]   # browser sign-in, or pass a token
quikrun new [name]      # scaffold a snippet into ./<name>
quikrun run             # test local source (--body, --method)
quikrun deploy          # ship it live at quik.run/r/<slug>
quikrun pull            # pull the deployed source back down
quikrun list            # list your team's snippets
quikrun logs            # recent run + deploy events

Typical flow

quikrun login
quikrun new my-webhook
cd my-webhook
quikrun run --method POST --body '{"name":"ada"}'
quikrun deploy

Upgrade

npm install -g quikrun@latest   # global install
npx quikrun@latest <command>    # npx: always the latest
›Env vars QUIKRUN_API_URL, QUIKRUN_WEB_URL, and QUIKRUN_TOKEN override the defaults for staging, local, or CI.