Frequently asked questions
Everything you need to know about publishing Markdown with OpenDocs.
What problem does OpenDocs solve?
In AI workflows you end up with a lot of .md files: architecture docs, changelogs, specs, runbooks. But sharing them is a pain. You either tell your team "open this file in Obsidian" or push to a repo and hope they find it. When you're moving fast, that friction kills momentum. OpenDocs lets you publish any Markdown file to a shareable URL in seconds, straight from the terminal or via your AI agent of choice.
How does it work?
Install the CLI, log in with an API key, and run opendocs publish doc.md. That's it. You get a clean, readable URL like opendocs.cc/you/doc-name that anyone can open in a browser. No git push, no deploy pipeline, no wiki to maintain.
Who can see my documents?
By default, documents are workspace-visible, meaning only members of your workspace can view them. This is the safe default for internal notes, specs, and drafts. If you want to share a document publicly (anyone with the link can read it), you explicitly set --visibility public. You're always in control.
Does it work with AI coding tools?
Absolutely, that's what it's built for. Claude Code, Cursor, GitHub Copilot, Cline, Aider, Codex, and any tool that can run terminal commands can publish to OpenDocs. The agent writes a Markdown file, runs the CLI, and hands you the link. The --json flag makes it easy for agents to parse the output programmatically.
How do I teach my AI agent to use OpenDocs?
We provide a SKILL.md file that teaches any AI agent how to use the OpenDocs CLI. Point your agent to the skill and it will know how to install the CLI, authenticate, publish, update, and manage documents on your behalf. This works with agents like OpenClaw, Claude Code, and any agent framework that supports skill files.
What's the difference between Free and Pro?
Free gives you 10 published documents, 1 workspace member, and workspace visibility. Pro ($8/month) unlocks unlimited documents, up to 10 workspace members, public publishing, custom profiles, and priority support. API access and the CLI are included on both plans.
Can I update a document after publishing?
Yes. Run opendocs update doc.md --post-id <id> and the document gets a new version. The URL stays the same, so anyone who already has the link sees the latest version automatically. Previous versions are preserved in the version history.
Do readers need an OpenDocs account?
No. Public documents can be read by anyone with the link, no sign-up, no login, no friction. Workspace-visible documents require the reader to be a member of your workspace.
Can I pull a document back to edit it locally?
Yes. Run opendocs pull <postId> to download the raw Markdown to a local file. You can also pipe it with --stdout. This makes the round-trip workflow easy: publish, share, get feedback, pull, edit, update.
What happens to my documents if I cancel Pro?
Your account reverts to Free at the end of the billing period. If you have more than 10 published documents, they all stay live and readable. You just can't publish new ones until you're under the limit or upgrade again. Nothing gets deleted.
Is OpenDocs open source?
Yes. The CLI, web app, and API are all open source under the MIT license. You can find the code on GitHub.
Still have questions?
Check the docs or jump in and try it. It's free to get started.