Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.useterse.ai/llms.txt

Use this file to discover all available pages before exploring further.

Terse is currently in private beta. Email us at support@useterse.ai to request access, and let us know what use cases you’re looking to build.
1

Install the CLI

npm install -g terse-cli
2

Scaffold a project

terse init my-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 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:
my-project/
  src/
    index.ts              # your job definitions
    terse.generated.ts    # generated SDK (do not edit)
  package.json
  tsconfig.json
  .env.example            # copy to .env when you need project-level env vars
  .gitignore
terse login during init stores CLI credentials in your user config, not in the project folder. Copy .env.example to .env when you want TERSE_API_KEY (or other secrets) available to your app or tooling as environment variables.
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, skill constructors, resource constants, and deterministic tool wrappers.
4

Test locally

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

Deploy

terse 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.

Templates

Start from a working workflow instead of a blank file.