insMind CLI documentation

Quick start

Node.js 20 or later is required. Install the CLI globally with one package manager:

npm install --global --allow-scripts=@insmind/cli @insmind/cli
# or
pnpm add --global --allow-build=@insmind/cli @insmind/cli

The package installs the bundled insmind-cli Skill. Check your status, authorize in the browser when needed, and verify your available credits:

insmind-cli auth status
insmind-cli auth login
insmind-cli credits
Let an Agent install it

Copy the prompt from the AI Agent tab on the home page. The Agent will install the package, complete login, and verify the Skill.

Login and insmind-cli Skill

Login

Check the current state first and authorize only when needed. insMind automatically binds the account context, so no context-selection step is required.

insmind-cli auth login [--no-browser]
insmind-cli auth status [--json]
insmind-cli auth logout
insmind-cli credits [--json]

insmind-cli Skill

Global installation and updates synchronize the bundled Skill so compatible Agents can discover models, choose creation routes, and use Editor and asset operations safely.

If installation used --ignore-scripts, or a Skill needs repair, run insmind-cli update. Restart the Agent or open a new session if it cannot see a newly installed Skill.

Agent and Tool creation

Use Agent for work that needs clarification, planning, multiple steps, or multiple deliverables. Use Tool for a direct image, video, or text operation. Always discover current Tools and Models before building input.

01

Agent: complete a business task

Read the input schema first. If you need a specific model, inspect the live Model details before sending the request.

insmind-cli agent send --schema
insmind-cli model list --tool <tool>
insmind-cli model get <model>
insmind-cli agent send --input request.json
insmind-cli agent send --input request.json --async
02

Tool: call one capability

Discover available Tools and Models, then construct input using the selected Model schema.

insmind-cli tool list
insmind-cli model list --tool <tool>
insmind-cli model get <model>
insmind-cli tool call <tool> --schema
insmind-cli tool call <tool> --input request.json
insmind-cli tool call <tool> --input request.json --async
Recover submitted creation tasks

Agent and Tool creation can return a task ID. Use the local task record to retrieve the original result without submitting or charging for another creation.

insmind-cli task list [--limit <number>] [--operation <agent.send|tool.call>]
insmind-cli task get <id>
  • Use explicitly authorized absolute paths for local media.
  • Do not hard-code Tools, Models, parameters, prices, or estimated duration.
  • Do not automatically retry a paid request whose submission status is unknown.
  • If output is missing, run insmind-cli task list and then insmind-cli task get <id>. A running, unknown, or timed-out query is not permission to resubmit.

Editor

Connect to one insMind Editor canvas in the browser, read its current state, apply structured actions, review a screenshot, and save explicitly.

insmind-cli editor connect [target]
insmind-cli editor snapshot
insmind-cli editor apply --input actions.json
insmind-cli editor screenshot --json
insmind-cli editor save --json
insmind-cli editor disconnect
Current boundary

Use a blank or dedicated canvas when existing content is unsupported, and never overwrite unrelated work.

Take a new snapshot after each apply. Saving waits for durable persistence and may be slower than other commands; keep the command running until it returns the work ID and URL.

Asset management

Discover available repositories, folders, and tags before searching, downloading, uploading, or organizing assets. Every repository, entry, and destination ID must come from current command output.

insmind-cli dam repository list --json
insmind-cli dam folder list --repository-id <id> --json
insmind-cli dam tag list --repository-id <id> --json
insmind-cli dam search <query> --repository-id <id>
insmind-cli dam get <asset> [--json]
insmind-cli dam download <asset> --repository-id <id> [--output-dir <directory>]
insmind-cli dam upload <file> --repository-id <id> --folder-id <folder-id>
insmind-cli dam rename <entry> --kind <asset|folder> --title <title> --repository-id <id>
insmind-cli dam move <entry> --kind <asset|folder> --target-folder-id <id> [options]
insmind-cli dam copy <entry> --kind <asset|folder> --target-folder-id <id> [options]
insmind-cli dam delete <asset> --repository-id <id>
  • Download, rename, move, and copy operate on one entry at a time.
  • Use --target-folder-id 0 explicitly when moving or copying to a repository root.
  • Deletion moves an asset to the recycle bin by default. Use --permanent only after explicit confirmation.
  • Obtain explicit user approval before reading or uploading files from protected paths.

Updates, output, and errors

insmind-cli update checks the npm latest version of @insmind/cli, updates a supported global installation, and synchronizes the bundled Skill.

Automatic version checks run at most once per hour and notify at most once per local day. A failed check does not block the command, and CI=true skips it.

insmind-cli update
0

Command succeeded.

1

Runtime, service, or state failure; follow only the recovery steps returned by the error.

2

Invalid command or arguments; check the relevant --help output.

130

Interrupted by the user; stop immediately and do not retry automatically.

stdout contains command results. stderr contains warnings, authorization instructions, and errors. If credits are insufficient, follow the returned purchase guidance before starting a new request.

Command reference

These are the currently supported public commands. Use global --locale <locale> to select the language of service-owned business descriptions; commands, identifiers, and parameters stay in English. Use the relevant --help output for current options.

insmind-cli [--locale <locale>] <command>
insmind-cli auth login [--no-browser]
insmind-cli auth status [--json]
insmind-cli auth logout
insmind-cli credits [--json]
insmind-cli agent send --schema
insmind-cli agent send --input <file|->
insmind-cli agent send --input <file|-> --async
insmind-cli tool list
insmind-cli tool call <tool> --schema
insmind-cli tool call <tool> --input <file|->
insmind-cli tool call <tool> --input <file|-> --async
insmind-cli model list [--tool <tool>]
insmind-cli model get <model>
insmind-cli editor connect [target]
insmind-cli editor disconnect
insmind-cli editor snapshot
insmind-cli editor apply --input <file|->
insmind-cli editor screenshot [--json]
insmind-cli editor save [--json]
insmind-cli dam repository list [--json]
insmind-cli dam folder list [options]
insmind-cli dam tag list [options]
insmind-cli dam list [options]
insmind-cli dam search <query> [options]
insmind-cli dam get <asset> [--json]
insmind-cli dam download <asset> [options]
insmind-cli dam upload <file> [options]
insmind-cli dam rename <entry> --kind <asset|folder> --title <title> [options]
insmind-cli dam move <entry> --kind <asset|folder> --target-folder-id <id> [options]
insmind-cli dam copy <entry> --kind <asset|folder> --target-folder-id <id> [options]
insmind-cli dam delete <asset> [options]
insmind-cli task list [--limit <number>] [--operation <agent.send|tool.call>]
insmind-cli task get <id>
insmind-cli update

Changelog

v1.4.0

Version stable actuelle
  • Agent workflows and direct Tool calls for image, video, and text creation.
  • Création synchrone ou asynchrone avec récupération locale des tâches, afin de récupérer un résultat existant sans nouvelle soumission.
  • Live Tool and Model discovery, including parameters, credits, and estimated duration.
  • Automatic insmind-cli Skill synchronization during global installation and updates.
  • Browser authorization with an automatically bound insMind account context.
  • Editor canvas inspection, structured editing, screenshot review, and save.
  • Asset repository, folder, tag, search, download, upload, rename, move, copy, and delete operations.
  • Stable structured output, exit codes, and actionable errors.