Quickstart

Run your first Poyesis pipeline in under five minutes.

This guide takes you from zero to a green deploy. You'll install the CLI, connect a repository, and watch a pipeline run end to end.

Prefer the dashboard? Every step here has a point-and-click equivalent at app.poyesis.dev. The CLI is just faster to document.

1. Install the CLI#

Verify the install:

Shell

poyesis --version
# → poyesis/1.4.0

2. Authenticate#

Shell

poyesis login

This opens your browser to authorize the CLI. A scoped, short-lived token is written to ~/.poyesis/credentials.

Never commit ~/.poyesis/credentials or a POYESIS_TOKEN to source control. For CI, use an organization token stored as an encrypted secret instead.

3. Connect a repository#

From inside a Git repository:

Shell

poyesis init

The CLI detects your stack and scaffolds a starter poyesis.yaml:

poyesis.yaml

version: 1
pipeline:
  - stage: build
    run: npm ci && npm run build
  - stage: test
    run: npm test
  - stage: deploy
    needs: [build, test]
    run: poyesis deploy --env production

4. Run it#

Shell

poyesis run

You'll see live logs stream in your terminal:

Text

✔ build   passed · 1m 42s
✔ test    248 passed · 0 failed
→ deploy  deploying to production…
✔ deploy  live at https://api.poyesis.dev

That's a full pipeline — source to production. Push a commit and Poyesis runs it again automatically.

Next steps#

Core concepts

Understand projects, pipelines, stages, and environments.

Pipelines guide

Caching, matrices, manual approvals, and reusable templates.