Use the mdplane CLI for workspace operations from a shell (init, read/cat, append, write, search, export, login, claim). Trigger when users ask for mdplane command usage or command-line automation. For HTTP-first usage, use mdplane.
Resources
1Install
npx skillscat add albri/mdplane/mdplane-cli Install via the SkillsCat registry.
SKILL.md
mdplane CLI
Use this skill when shell access is available and the task should be solved with mdplane commands.
Operating Rules
- OpenAPI and server behavior are the source of truth.
- Do not invent commands, flags, or response fields.
- Prefer least privilege:
- read key for read/search (scoped)
- append key for appends
- write key only for mutating file/folder state
- API key for
/api/v1/*control endpoints (workspace-wide search, exports, deleted, agents)
- Never print capability URLs, API keys, or session tokens.
Standard Workflow
- Confirm deployment target (
https://api.mdplane.dev, self-host, or local). - Resolve auth mode from profile/env/flags.
- Execute command(s) with minimal required capability.
- Validate outcomes (
status,files,read,check-keysas needed). - Summarize results and any follow-up action.
Command Surface
The canonical command inventory and auth expectations are in:
./references/command-surface.md
Use it before giving command guidance.
Canonical References
./references/canonical-links.md
Read these references when the request touches new endpoints, auth edge cases, orchestration, webhooks, export, or folder operations.
Quick Checks
mdplane --help
mdplane <command> --helpIf CLI behavior appears to drift from docs, trust source and OpenAPI links in references and flag the drift.