> ## Documentation Index
> Fetch the complete documentation index at: https://vlyai-1c28d863.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> @vly/cli — terminal access to the same API. Useful for scripts, CI, and quick automation.

The vly CLI is a thin wrapper over the REST API. Use it for scripts, CI pipelines, or quick one-off automation.

## Install

```bash theme={null}
npm install -g @vly/cli
```

## Authenticate

```bash theme={null}
vly login
# Or, set the API key directly:
export VLY_API_KEY=vly_live_...
```

## Common commands

<CodeGroup>
  ```bash projects theme={null}
  vly projects list
  vly projects create --name "My App" --prompt "..."
  vly projects get prj_01...
  vly projects update prj_01... --visibility public
  ```

  ```bash deployments theme={null}
  vly deployments create prj_01... --environment production
  vly deployments get dpl_01...
  vly deployments rollback prj_01... --to dpl_01...
  ```

  ```bash agents theme={null}
  vly agents run prj_01... --prompt "Add a settings page"
  vly agents tail run_01...           # stream output
  ```

  ```bash secrets theme={null}
  vly secrets set STRIPE_SECRET_KEY sk_live_... --env production
  vly secrets list --env production
  vly secrets delete OLD_KEY --env production
  ```

  ```bash files theme={null}
  vly files upload prj_01... ./image.png --path /uploads/image.png
  vly files list prj_01...
  ```
</CodeGroup>

## In CI

GitHub Actions example:

```yaml theme={null}
- name: Trigger production deploy
  env:
    VLY_API_KEY: ${{ secrets.VLY_API_KEY }}
  run: |
    npm install -g @vly/cli
    vly deployments create $PROJECT_ID --environment production --wait
```

The `--wait` flag blocks until the deployment finishes (success or failure), exiting with the appropriate status code for CI gating.

## Related

<CardGroup cols={3}>
  <Card title="TypeScript SDK" icon="code" href="/api-reference/sdks/typescript">
    Programmatic access.
  </Card>

  <Card title="Python SDK" icon="code" href="/api-reference/sdks/python">
    Programmatic access.
  </Card>

  <Card title="GitHub integration" icon="github" href="/integrations/github">
    Auto-deploy on push.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.