flexkit project

Manages projects in your Flexkit account.

Synopsis

flexkit project <subcommand> [arguments] [options]

Subcommands

project ls

List projects, or fetch a single project by name or id.

flexkit project ls [nameOrId] [--json] [--scope <scope>]

Examples

# List projects
flexkit project ls
 
# List projects for a specific scope
flexkit project ls --scope my-team
 
# Get one project
flexkit project ls my-project
 
# JSON output
flexkit project ls --json

project add

Create a project.

flexkit project add <name> [--json] [--scope <scope>]

Examples

# Create project
flexkit project add my-project
 
# Create in a team scope
flexkit project add my-project --scope team-id-or-name
 
# JSON output
flexkit project add my-project --json

project rm

Remove a project by id or name. The CLI prompts for confirmation before deletion.

flexkit project rm <nameOrId> [--json] [--scope <scope>]

Examples

# Remove project
flexkit project rm my-project
 
# Remove from specific scope
flexkit project rm my-project --scope team-id-or-name
 
# JSON output
flexkit project rm my-project --json

project pause

Pause a project on a Pro plan: GraphQL, automations and agent chat stop until an owner unpauses it. This is the Pause project button of the project settings in the dashboard. Like the dashboard, the CLI shows the project’s state and asks you to type the project’s name; --yes skips that, and is required without a terminal.

flexkit project pause [--project <id>] [--yes] [--json]

It acts on the project given with --project, FLEXKIT_PROJECT_ID, or the linked project. Pausing a project that is already paused changes nothing. A project paused by on-demand usage limits can’t be paused or unpaused here: raise the monthly limit or switch to Unlimited in the dashboard’s spend management.

Examples

# Pause the linked project (asks for its name)
flexkit project pause
 
# Pause another project from a script
flexkit project pause --project 3pbqd8xkz1 --yes
 
# JSON output: {"status":"paused","success":true}
flexkit project pause --yes --json

project unpause

Bring a paused project back online.

flexkit project unpause [--project <id>] [--json]

A project that is read-only because an invoice is overdue stays read-only until the invoice is paid in the dashboard’s Billing page, and a project paused by on-demand usage limits is restored from spend management.

Examples

# Unpause the linked project
flexkit project unpause
 
# Unpause another project
flexkit project unpause --project 3pbqd8xkz1

Options

Permissions

pause and unpause need the Owner role and a signed-in session from flexkit login. Project API tokens can’t pause or unpause a project, whatever their role, and are refused with A user session is required. Only projects on a Pro plan can be paused.

You can also use all global options.