Skip to content

skystate project

Manage SkyState projects.

Synopsis

skystate project [list]
skystate project create <name> <slug>
skystate project show <slug>
skystate project delete <slug> [--yes]

project list is the default subcommand when none is specified — running skystate project is equivalent to skystate project list.


skystate project list

List all projects on your account.

Synopsis

skystate project list [--format <format>] [--quiet]

Description

Fetches all projects and displays them as a table of slugs. Use --format json to get the full API response including projectId, name, and slug.

Options

--format, --quiet — see global options.

Examples

sh
skystate project list
skystate project list --format json

Output (default table format)

slug
--------
my-app
backend-api

Output (JSON format)

json
[
  {
    "projectId": "proj_abc123",
    "name": "My App",
    "slug": "my-app"
  },
  {
    "projectId": "proj_def456",
    "name": "Backend API",
    "slug": "backend-api"
  }
]

Errors

SituationExit CodeMessage
Not authenticated2Not authenticated. Run: skystate login
No projects existNo projects found. Create one with: skystate project create <name> <slug>

skystate project create

Create a new project.

Synopsis

skystate project create <name> <slug>

Arguments

ArgumentDescription
<name>Human-readable project name (e.g., My App)
<slug>URL-safe project identifier (e.g., my-app)

Description

Creates a project with the given name and slug. The slug must be unique within your account and is used in API keys, CLI commands, and public config URLs.

Options

--format, --quiet — see global options.

Examples

sh
skystate project create "My App" my-app
skystate project create "Backend API" backend-api --format json

Output (default format)

Project created
projectId   proj_abc123
name        My App
slug        my-app

Output (JSON format)

json
{
  "projectId": "proj_abc123",
  "name": "My App",
  "slug": "my-app"
}

Errors

SituationExit CodeMessage
Not authenticated2Not authenticated. Run: skystate login
Slug already taken1API error message from server
Plan project limit reached78Error: Limit exceeded

skystate project show

Show details for a single project.

Synopsis

skystate project show <slug>

Arguments

ArgumentDescription
<slug>The project slug

Options

--format, --quiet — see global options.

Examples

sh
skystate project show my-app
skystate project show my-app --format json

Output (default format)

slug        my-app
name        My App
projectId   proj_abc123

Output (JSON format)

json
{
  "slug": "my-app",
  "name": "My App",
  "projectId": "proj_abc123"
}

Errors

SituationExit CodeMessage
Project not found1Error: Project not found: my-app with hint Check the slug with: skystate project list
Not authenticated2Not authenticated. Run: skystate login

skystate project delete

Permanently delete a project and all its data.

Synopsis

skystate project delete <slug> [--yes]

Arguments

ArgumentDescription
<slug>The project slug to delete

Options

OptionDescription
--yesSkip the confirmation prompt

Description

Deletes the project identified by <slug> and all associated data (environments, config versions, API keys). This action is irreversible.

Without --yes, the command requires interactive input. It displays a warning and prompts you to type the project slug to confirm:

This will permanently delete project "My App" (my-app) and all its data.
Type the project slug to confirm: my-app

If the typed slug does not match, the deletion is aborted.

Examples

sh
# Interactive deletion with confirmation
skystate project delete my-app

# Non-interactive deletion (CI/scripts)
skystate project delete my-app --yes

Output

Deleted project: my-app

Errors

SituationExit CodeMessage
Project not found1Error: Project not found: my-app with hint Check the slug with: skystate project list
Not authenticated2Not authenticated. Run: skystate login
Aborted by userAborted. (exit code 0)
Non-TTY without --yes1Error: This command requires an interactive terminal. Use --yes to skip confirmation.

Dashboard equivalent

Projects can be deleted from Project Settings in the dashboard at https://app.skystate.io.

Built with VitePress