CLI reference — Nyas Docs

CLI command reference

This reference is rendered from the checked-in public CLI contract. Hidden installer configuration commands are intentionally omitted.

`nyas login`

nyas login

`nyas logout`

Remove stored Nyas credentials.

nyas logout

`nyas start`

Create a project and wait until it is ready.

nyas start [OPTIONS]

Options--json--wait-timeout <WAIT_TIMEOUT>

`nyas create`

Create a named project and wait until it is ready.

nyas create <PROJECT_NAME> [OPTIONS]

Options--plan <free|starter|growth>--json

`nyas list`

List projects in the current account.

nyas list [OPTIONS]

Options--json

`nyas project`

Show a project and its connection credentials.

nyas project <PROJECT_ID> [OPTIONS]

Options--json

`nyas rename`

Rename a project.

nyas rename <PROJECT_ID> <PROJECT_NAME> [OPTIONS]

Options--json

`nyas password-set`

Set the password for a ready database.

nyas password-set <PROJECT_ID> <PASSWORD> [OPTIONS]

Options--json

`nyas password-regenerate`

Generate a new database password.

nyas password-regenerate <PROJECT_ID> [OPTIONS]

Options--json

`nyas usage`

Show project storage, query, and connection usage.

nyas usage <PROJECT_ID> [OPTIONS]

Options--json

`nyas ping`

Check control-plane connectivity to a database.

nyas ping <PROJECT_ID> [OPTIONS]

Options--json

`nyas delete`

Permanently delete a project and its owned resources.

nyas delete <PROJECT_ID> [OPTIONS]

Options--yes--json

`nyas migrate`

Migrate an existing PostgreSQL database into Nyas.

nyas migrate <PROJECT_SELECTOR> --from <SOURCE> [OPTIONS]

Options--from <SOURCE>--json

`nyas migrate-status`

Show a running migration.

nyas migrate-status <MIGRATION_ID> [OPTIONS]

Options--json

`nyas migrations`

List account migrations.

nyas migrations [OPTIONS]

Options--json

`nyas restores`

List restores for a project.

nyas restores <PROJECT_ID> [OPTIONS]

Options--json

`nyas restore-availability`

Show available restore windows and backups.

nyas restore-availability <PROJECT_ID> [OPTIONS]

Options--json

`nyas restore-create`

Queue a point-in-time or scheduled-backup restore.

nyas restore-create <PROJECT_ID> --mode <pitr|scheduled-backup> [OPTIONS]

Options--mode <pitr|scheduled-backup>--timestamp <TIMESTAMP>--scheduled-backup-id <SCHEDULED_BACKUP_ID>--json

`nyas restore-status`

Show a restore operation.

nyas restore-status <RESTORE_ID> [OPTIONS]

Options--json

`nyas storage-settings`

Show project storage settings.

nyas storage-settings <PROJECT_ID> [OPTIONS]

Options--json

`nyas storage-settings-set`

Update the project file-size limit.

nyas storage-settings-set <PROJECT_ID> --max-file-size-bytes <MAX_FILE_SIZE_BYTES> [OPTIONS]

Options--max-file-size-bytes <MAX_FILE_SIZE_BYTES>--json

`nyas sql`

Open an interactive SQL session.

nyas sql <PROJECT_ID>

`nyas store`

Open the interactive storage shell.

nyas store <PROJECT_ID>

`nyas db`

Manage a project's database lifecycle.

nyas db

`nyas db create`

Provision a database in an existing project.

nyas db create [OPTIONS]

Options--project-id <PROJECT_ID>--json

`nyas db stop`

Stop a database while retaining its disk and connection string.

nyas db stop [OPTIONS]

Options--project-id <PROJECT_ID>--json

`nyas db start`

Start a stopped database.

nyas db start [OPTIONS]

Options--project-id <PROJECT_ID>--json

`nyas db destroy`

Destroy a database and all of its backups.

nyas db destroy [OPTIONS]

Options--project-id <PROJECT_ID>--yes--json

`nyas edge`

Manage project-scoped edge workers.

nyas edge

`nyas edge init`

Create a Rust WASI edge-worker template.

nyas edge init [DIR] --project-id <PROJECT_ID> --name <NAME>

Options--project-id <PROJECT_ID>--name <NAME>

`nyas edge deploy`

Build or upload an edge worker.

nyas edge deploy <PROJECT_ID> [PATH] --name <NAME> --route <ROUTE> [OPTIONS]

Options--name <NAME>--route <ROUTE>--json

`nyas edge invoke`

Invoke a deployed edge worker.

nyas edge invoke <PROJECT_ID> <NAME> [-- <ARGS>…] [OPTIONS]

Options--json

`nyas edge list`

List project edge workers.

nyas edge list <PROJECT_ID> [OPTIONS]

Options--json

`nyas edge delete`

Delete an edge worker.

nyas edge delete <PROJECT_ID> <NAME> [OPTIONS]

Options--json

`nyas deploy`

Build and deploy an application directory.

nyas deploy [PATH] [OPTIONS]

Options--project-id <PROJECT_ID>--json

`nyas rollback`

Roll an application back to an earlier version.

nyas rollback [OPTIONS]

Options--project-id <PROJECT_ID>--to-version <TO_VERSION>--json

`nyas app`

Deploy and manage containerized applications.

nyas app

`nyas app build`

Inspect generated application build configuration.

nyas app build

`nyas app build check`

Check generated application build configuration.

nyas app build check [PATH] [OPTIONS]

Options--json

`nyas app status`

Show the live application deployment.

nyas app status <PROJECT_ID> [OPTIONS]

Options--json

`nyas app logs`

Show logs for the latest deployment.

nyas app logs <PROJECT_ID> [OPTIONS]

Options--json

`nyas app stop`

Stop the application host while retaining its volume.

nyas app stop [OPTIONS]

Options--project-id <PROJECT_ID>--json

`nyas app start`

Start a stopped application host.

nyas app start [OPTIONS]

Options--project-id <PROJECT_ID>--json

`nyas app destroy`

Destroy the application and terminate its host.

nyas app destroy [OPTIONS]

Options--project-id <PROJECT_ID>--yes--json

`nyas mcp`

Start the local stdio MCP server.

nyas mcp