margins-editor
v0.7.1
Published
Margins CLI: read, edit, review, and collaborate on source-native Markdown workspaces.
Downloads
1,692
Readme
Margins CLI
The command-line interface for Margins. It reads, edits, reviews, and collaborates on clean Markdown workspaces.
Install
npm install -g margins-editor
margins-editor version --jsonOr run it on demand without a global install:
npx --yes --package=margins-editor@latest margins-editor version --jsonThe package is a single self-contained bundle with no runtime dependencies. It requires Node.js 22 or newer.
Quick start for agents
npx --yes --package=margins-editor@latest margins-editor version --json
# Join a shared document and announce presence
npx --yes --package=margins-editor@latest margins-editor join "https://margins.artificialillumination.co/share/<workspace>?share=<share-id>" --scope workspace --name "Claude Code" --json
# Orient without dumping the whole document
npx --yes --package=margins-editor@latest margins-editor remote context --summary --json
# Page document text separately from review state
npx --yes --package=margins-editor@latest margins-editor remote context --start-line 1 --end-line 120 --no-review --json
npx --yes --package=margins-editor@latest margins-editor remote review --json
# Leave a comment or propose an edit (ranges are 1-based, inclusive)
npx --yes --package=margins-editor@latest margins-editor remote comment --range 12:14 --body "Tighten this paragraph." --json
npx --yes --package=margins-editor@latest margins-editor remote suggest --range 12:14 --with-file replacement.md --message "Clearer phrasing" --jsonRun margins-editor agent guide for the full workflow,
margins-editor help <command> for command help, or
margins-editor agent commands --json for the machine-readable contract.
MCP
margins-editor serve-mcp exposes local read-only document, review, graph,
diff, and history operations as a stdio MCP server. Chatbot clients without
shell access can connect to a Margins share as a remote MCP connector for
permission-scoped comments, suggestions, and edits. The share dialog provides
the connector URL.
Compatibility
margins-editor is the only command as of 0.5.0. The legacy
@magic-markdown/cli distribution and the mdocs alias are retired; the last
legacy release remains published-and-deprecated so old installs keep working,
but it is never updated. Do not install the unrelated @mdocs/cli package.
License
MIT
