CI/CD Usage

Every CreateOS CLI command works in non-interactive mode. Use flags instead of prompts, --output json for machine-readable output, and --force to skip confirmation prompts.

Authentication in CI

Use an API token instead of browser OAuth:

Bash
Copy
1createos login --token

Set the token via environment variable or pipe it in. Get your API key from Profile Settings > API Keys in the CreateOS dashboard.

Common CI commands

Deploy

Bash
Copy
1createos deploy --project $CREATEOS_PROJECT_ID

Set environment variables from CI secrets

Bash
Copy
1createos env set \
2  DATABASE_URL=$DB_URL \
3  API_KEY=$API_KEY \
4  --project $CREATEOS_PROJECT_ID \
5  --environment $CREATEOS_ENV_ID

Push a local .env file

Bash
Copy
1createos env push --file .env.production --project $ID --environment $ID --force

Check deployment status

Bash
Copy
1createos status --project $ID --output json

Delete resources without prompts

Bash
Copy
1createos domains delete --project $ID --domain $DOMAIN_ID --force
2createos deployments cancel --project $ID --deployment $DEPLOY_ID --force
3createos cronjobs delete --project $ID --cronjob $CRON_ID --force

JSON output

Add --output json or -o json to any list or get command:

Bash
Copy
1# Get project list as JSON
2createos projects list --output json
3
4# Parse with jq
5createos status --output json | jq '.project.status'
6
7# Use in scripts
8DEPLOY_URL=$(createos deployments list -o json | jq -r '.[0].extra.endpoint')

GitHub Actions example

YAML
Copy
1name: Deploy to CreateOS
2on:
3  push:
4    branches: [main]
5
6jobs:
7  deploy:
8    runs-on: ubuntu-latest
9    steps:
10      - uses: actions/checkout@v4
11
12      - name: Install CreateOS CLI
13        run: curl -sfL https://raw.githubusercontent.com/NodeOps-app/createos-cli/main/install.sh | sh -
14
15      - name: Authenticate
16        run: createos login --token
17        env:
18          CREATEOS_API_KEY: ${{ secrets.CREATEOS_API_KEY }}
19
20      - name: Deploy
21        run: createos deploy --project ${{ vars.PROJECT_ID }}

Environment variables

Non-interactive behavior

When the CLI detects a non-TTY environment (piped output, CI runner), it:

• Skips all interactive prompts
• Requires explicit flags for any selection (project, environment, deployment)
• Returns clear error messages if required flags are missing
• Outputs JSON by default when piped

Bash
Copy
1# This works in CI (explicit flags)
2createos env list --project abc-123 --environment prod-456
3
4# This fails in CI (would need interactive selection)
5createos env list
6# Error: non-interactive mode: use --project and --environment flags