Kortyx Studio CLI Commands

Updated 17 minutes ago • August 2, 2026

The kortyx studio commands manage the local Docker-based installation. Run them through the public kortyx package:

Local state is stored in ~/.kortyx/studio by default. Commands reuse that state, so credentials and database data survive ordinary stop, restart, CLI upgrades, and repeated starts.

Everyday commands

Command	Purpose	Preserves data?
`npx kortyx studio start`	Create or update the stack and wait until healthy	Yes
`npx kortyx studio status`	Show container state and local endpoints	Yes
`npx kortyx studio logs`	Follow API, Studio, bootstrap, and database logs	Yes
`npx kortyx studio logs --no-follow`	Print recent logs and return	Yes
`npx kortyx studio credentials`	Print the current local connection details	Yes
`npx kortyx studio restart`	Recreate the stack and wait until healthy	Yes
`npx kortyx studio stop`	Stop the containers	Yes

Good to know: Start is idempotent. Running it again is the normal way to bring back a stopped installation or apply a changed image tag or port configuration.

Start options

Choose different host ports:

Pin both Studio images to an immutable published release:

Use an alternate state directory or local username:

The same --home value must be supplied to later commands. Alternatively, set KORTYX_STUDIO_HOME for the shell or automation that manages that installation.

Print or rotate local credentials

Print the current browser and SDK connection values:

Replace the browser password and both application API-key secrets:

Rotation updates the local environment atomically, applies new key verifiers, recreates affected services, and attempts rollback if the application fails. The previous telemetry key becomes invalid, so update and restart every local SDK producer.

The database password and API-key pepper are deliberately preserved.

Generate credentials for remote deployment

This produces an unpersisted credential set without creating local Studio state. Store it immediately in the deployment's secret manager. It cannot be printed again later.

See Credentials and Secrets before using generated values on a server.

Reset local data

Destructive command: Reset permanently deletes the local PostgreSQL volume. It preserves generated credentials, so the next studio start creates an empty database and bootstraps those keys again.

Back up any telemetry you need before resetting. See Operations and Troubleshooting.

Local CLI versus remote operation

The current CLI manages the local Compose stack. It does not SSH into servers, edit a remote database, or replace your cloud platform's deployment tools.

For remote environments, use Deploy on a Server, inject secrets through the platform, and operate the same container contract through your infrastructure tooling.