Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

@zot-core/cli

Command-line interface for the Zot API.

npx @zot-core/cli waitlist create --name "Early Access" --write-env .env.local --public

Install

npm install -g @zot-core/cli        # global
npm install -D @zot-core/cli        # as a devDependency
npx @zot-core/cli <command>         # one-off

After installing, the binary is exposed as zot-cli:

zot-cli waitlist create --name "Early Access"

Authentication

Every command needs a Zot API key. Resolution order:

  1. --api-key <key> flag
  2. ZOT_API_KEY environment variable
  3. .env.local in the working directory
  4. .env in the working directory

Get your key at https://app.zot.so/app/api-keys.

Commands

zot-cli waitlist create

Create a waitlist via the API and optionally persist its ID into a .env file.

zot-cli waitlist create --name "Early Access"
zot-cli waitlist create --name "Early Access" --write-env .env.local
zot-cli waitlist create --name "Early Access" --write-env .env.local --public
zot-cli waitlist create --name "Quiet"        --no-send-email
zot-cli waitlist create --name "Scripted"     --json
Flag Default Description
--name (required) Waitlist name.
--api-key $ZOT_API_KEY Override the resolved API key.
--send-email / --no-send-email true Send a welcome email to new signups.
--write-env <file> none Upsert ZOT_WAITLIST_ID into that env file.
--public false Also write NEXT_PUBLIC_ZOT_WAITLIST_ID (requires --write-env).
--cwd <dir> process.cwd() Working directory for env resolution / writing.
--json Emit the waitlist JSON instead of a formatted summary.

Standard oclif flags like --help, -h, -v work everywhere.

Related

  • @zot-core/sdk — the TypeScript SDK the CLI wraps.
  • @zot-core/agents — configure AI coding agents (Claude Code, Cursor, Copilot, AGENTS.md) with Zot integration guides.