Skip to main content
The Softr CLI (softr) works with your Softr workspace from your machine. It is made for coding agents and works by hand as well: every command has a --json form, and nothing runs on your machine. Whatever the CLI tests or runs happens in Softr, exactly as in the builder. Today it covers your account and workspace (logging in, your workspaces, the integrations connected in them), workflows and Softr Databases. Each further area of Softr gets a section on this page and a skill of its own. The full command reference, with every option, is the README on the package page on npm; this page says what the CLI is for and how to start.

​
Before you start

  • A Softr workspace.
  • Node.js 22 or newer on the machine the CLI runs on.
  • For agents: one that reads skills in the Agent Skills format. Claude Code, Cursor, Codex and most others do.
With an agent you do not install the CLI: you add the Softr skills, and the softr-cli skill tells the agent how to install and update the CLI and how to log you in. Every other Softr skill, such as softr-workflows, builds on it. Add the skills once, for the agent you use.

​
Claude Code

Claude Code installs the Softr skills as one plugin and keeps them updated: it refreshes the marketplace in the background and picks up new versions. Inside Claude Code:
/plugin marketplace update softr-io-skills refreshes by hand; /plugin uninstall softr@softr-io-skills removes it.

​
Every other agent

Codex, Cursor, Gemini CLI, GitHub Copilot, OpenCode and most other agents read skills from .agents/skills/ in a project or in your home directory. The skills CLI puts a copy there and links it wherever an agent expects its own directory:
Run it in a project to add the skills to that project, or with -g to add them for every project. The copy does not update on its own: npx skills update brings every installed skill up to date. Any agent that reads SKILL.md files can also take a folder straight from the skills repository.

​
Install the CLI yourself

Using a coding agent? Skip this section. The softr-cli skill installs and updates the CLI for you, and this page’s sections below describe what the agent does with it.
For your own use in a terminal:
npm update -g @softr/cli brings a global install up to date. Node.js 22 or newer is required either way.

​
Log in

See personal API tokens for how to create one, and softr login --help for every other way to log in, for example in scripts. An agent asks you to do this once, in your own terminal. The CLI has exactly the rights you have in Softr, never more; softr whoami shows them and softr logout forgets the token.

​
Workflows

The softr workflows commands treat a workflow like a small project: one directory per workflow, the definition in a softr-workflows.jsonc file, and every Run custom code step as a real JavaScript or Python file next to it. The CLI pulls a workflow into those files, pushes edits back as a new draft, tests every step against real data, verifies the whole workflow and publishes it. Every test and every run happens in Softr.
The CLI offers a small, deliberate set of step types: the generic triggers (webhook, schedules, Softr Databases and Softr app events, incoming email), the control steps (branch, filter, loop, wait), Respond to webhook, Call API and Run custom code. Workflows made of many third-party integration steps are built in the builder or through the Softr MCP server, which reaches every step type.
Skill: softr-workflows. With it, the agent creates the workflow, writes the code, tests every step and publishes it, with the files in your project as the record. Ask for the outcome, not the steps:
Create a Softr workflow that receives a webhook with a lead, scores it in Python, and answers the webhook with the score.
The agent initializes the workflow, adds the steps, writes the code files, pushes them, tests each step, verifies the whole workflow and, when you confirm, publishes it. The trigger’s URL and a link to the workflow in Softr Studio are in its output, and the workflow opens in the builder like any other.

​
Databases

The softr db commands create and shape Softr Databases (databases, their tables, fields and views) and read and write their records. A database gets a directory of its own, with a softr-db.jsonc file that names it and a cache of its tables and fields that the CLI keeps up to date. Next to your workflow directories, it gives the agent the table and field ids a workflow needs. Every change goes to Softr at once. Skill: softr-db. Ask for the outcome:
Create a Softr database for my CRM with a Leads table: name, email, a stage with New, Qualified and Won, and a follow-up date.
The agent creates the database and its directory, adds the table and its fields, and shows you the result. It asks before it deletes anything. Records use field names in both directions, and they are never stored on your machine. softr db --help lists the commands.

​
Learn more

@softr/cli on npm

The full command reference, in the package README.

softr-io-skills on GitHub

The skills and their references, in the Agent Skills format.

Workflows

Triggers, steps and how workflows run.

Softr Databases

Tables, field types and how Softr stores your data.

Softr MCP server

Build workflows with every step type through an AI assistant.