Skip to main content
1

Install Terse

One command on a fresh machine: installs the CLI globally (when you confirm) and walks you through terse auth login. Run terse update later to refresh the CLI.If you prefer to install only the CLI, use npm install -g terse-cli instead.
2

Scaffold a project

terse init handles the full setup in one command:
  1. Scaffolds your TypeScript project files (src/index.ts, config, etc.)
  2. Installs dependencies
  3. Opens the browser to authenticate via terse auth login
  4. Checks your connected integrations and prompts you to add more if needed
  5. Runs terse generate to produce a typed SDK from your workspace
After init, your project looks like this:
terse auth login during init stores CLI credentials in your user config, not in the project folder, so .env.example starts empty: copy it to .env and add whatever your own code needs. Neither Terse credential belongs there. Your workflow code receives a project-scoped TERSE_PROJECT_KEY automatically on every run, and the CLI reads TERSE_API_KEY from your user config. See API key resolution.
3

Write your workflow

Open src/index.ts and define a job. The scaffolded file includes a starter example. Your generated SDK gives you typed helpers for every integration you connected: trigger builders and resource constants.
4

Test locally

Runs your workflow locally against the Terse backend so you can verify it works before deploying.
5

Deploy

Your code is packaged, uploaded, and hosted serverlessly. Navigate to the link provided to monitor your workflow. Learn more about how deployment works.

​
What to do next

Context as Code

Understand what terse generate produces and why it matters.