Flexkit CLI
Flexkit CLI is the command-line interface for managing Flexkit projects from your terminal.
Use it to authenticate, deploy schemas, work with records, manage automations, skills, knowledge and plugins, talk to the Chat Agent, and script anything else the Flexkit API offers without leaving your terminal.
Usage
Install the CLI globally with npm:
npm install --global @flexkit/cli
Example commands:
flexkit login
flexkit link # link this folder to a project; later commands use it
flexkit deploy # deploy the schema from flexkit.config.ts
flexkit schema diff # compare the local schema with the deployed one
flexkit dev # run the tools and skills from flexkit.tools.ts as your local runtime
flexkit records ls product --limit 10
flexkit query '{ products(limit: 5) { _id sku name { default } } }'
flexkit chat "Which orders shipped late this week?"
flexkit automations ls
flexkit runs logs <runId> --follow
flexkit skills pull ./skills # keep skills in git; push them back with `flexkit skills push`
flexkit knowledge add ./docs --wait
flexkit logs --since 1h --follow # API request logs; also `logs webhooks` and `logs llm`
flexkit webhooks ls
flexkit members invite [email protected] --role developer
flexkit tokens create ci --role developer # for FLEXKIT_TOKEN in CI
flexkit api /automations # call any API endpoint with your credentials
Every command prints help with examples: flexkit <command> --help. Commands that read data accept --json and print it on stdout, so the output can be piped to jq.
In CI, set FLEXKIT_TOKEN and FLEXKIT_PROJECT_ID instead of logging in. API tokens can't manage tokens or members, pause the project, or read anyone's chats and agent memory; those need flexkit login.
Documentation
For details on how to use Flexkit CLI, check out our documentation.
Contributing
Contributions to Flexkit are welcome and highly appreciated. However, before you jump right into it, we would like you to review our Contribution Guidelines to make sure you have a smooth experience contributing to Flexkit.
Reporting Issues
Found a bug? Have a feature request?
Open an issue with: • Repro steps • Expected vs actual behavior • Screenshots when helpful • Schema snippet (if relevant)
License
This project is licensed under the MIT license.
See LICENSE for more information.
Security
If you believe you have found a security vulnerability in Flexkit, we encourage you to responsibly disclose this and NOT open a public issue.
See SECURITY.md for how to report.