Flexkit CLI

The Flexkit CLI lets you do from your terminal what you do in the Dashboard and Studio: deploy your schema, work with records, manage automations, skills, knowledge and plugins, talk to the Chat Agent, and script anything else the Flexkit API offers.

Every command prints its options and examples with flexkit <command> --help.

Install

pnpm

pnpm add -g @flexkit/cli

npm

npm install -g @flexkit/cli

yarn

yarn add -g @flexkit/cli

bun

bun add -g @flexkit/cli

Updating Flexkit CLI

The easiest way to update the Flexkit CLI is by running the installation command yet again.

pnpm

pnpm add -g @flexkit/cli@latest

npm

npm install -g @flexkit/cli@latest

yarn

yarn add -g @flexkit/cli@latest

bun

bun add -g @flexkit/cli@latest

Get started

# Log in, then link this folder to a project
flexkit login
flexkit link
 
# Commands in this folder now act on the linked project
flexkit schema show
flexkit records ls product --limit 10
flexkit automations ls
flexkit chat "Which products have no description?"

Commands that act on a project use the linked project, or the one you pass with --project. See how commands choose a project.

Usage

flexkit [options] <command> [subcommand] [arguments]

Commands

Project setup

Command	What it does
`login`	Log in to your Flexkit account.
`logout`	Log out and remove the stored credentials.
`whoami`	Show who you are logged in as.
`link`	Link the current folder to a project.
`unlink`	Remove the link of the current folder.
`project`	List, create, remove, pause and unpause projects.
`deploy`	Deploy the schema from `flexkit.config.ts` and follow its progress.
`deployments`	List, inspect and replay schema deployments.
`schema`	Pull, show and diff the deployed schema.
`dev`	Run the custom tools and code skills from `flexkit.tools.ts` locally.
`tools`	Sync the production custom-tools catalog.
`webhooks`	Create, edit, enable and delete webhooks.
`cors`	Manage the browser origins allowed to call the API.
`logs`	Show API, webhook and AI request logs, or follow them live.

Data

Command	What it does
`records`	List, read, count, create, update and delete records.
`search`	Search the project’s records.
`query`	Run a GraphQL query or mutation.
`assets`	Upload and export assets.
`import`	Import entities and assets from NDJSON, a directory or a tarball.
`export`	Export the full dataset to a tarball.

AI

Command	What it does
`chat`	Talk to the project’s Chat Agent, or list and read chats.
`automations`	Create, edit, enable and run automations.
`runs`	Follow, inspect and cancel automation runs.
`approvals`	Approve or deny the changes agents ask to make.
`skills`	Manage skills, or keep them as Markdown files in git.
`knowledge`	Upload, search and link knowledge documents.
`plugins`	Install and connect plugins.
`mcp`	Connect Claude, Cursor and other AI clients to the project.
`memory`	Read and edit what the agent remembers about you.

Account

Command	What it does
`activity`	Read the project’s activity inbox.
`usage`	Show usage against the plan limits.
`members`	Invite, remove and change the roles of project members.
`tokens`	Create, list and revoke project API tokens.
`api`	Send an authenticated request to any API endpoint.
`help`	Show usage for the CLI or a command.

Scripting and CI

Every command that reads data accepts --json and prints JSON on stdout, while messages and tables go to stderr. Pipe the output to jq safely.
Destructive commands ask for confirmation. Pass --yes to skip the prompt; without a terminal they refuse to run unless you do.
Set FLEXKIT_TOKEN and FLEXKIT_PROJECT_ID to run commands in CI without flexkit login. A token acts with its own role. Some things need a person and refuse tokens: managing tokens and members, project pause, deciding approvals, connecting plugins, usage, and personal data (chat, activity, memory). Their pages say so.

# Fail a CI job when an automation run fails
flexkit automations run aut_123 --wait
 
# Count the products that are in stock
flexkit records count product --where '{"stock":{"gt":0}}'

See Global options and the CI guide.