JotBirdJotBird
Open app
CLI

Publish Markdown from your terminal.

The JotBird command line interface (CLI) is all it takes to go from Markdown file to shareable link. Three commands. No browser needed. Used by developers, educators, and researchers worldwide.

$npm install -g jotbird

How it works

From install to published link in under a minute. Perfect for LLM workflows, CI pipelines, and Markdown-first publishing.

Step 1

Install

One command to install. Works anywhere Node.js runs: npm install -g jotbird
Step 2

Authenticate

Run jotbird login to link your account. One-time setup, takes seconds. Don't have an account? Create one for free.
Step 3

Publish

Run jotbird publish file.md to get a shareable link. Update anytime with the same command.

Unlike gists, pastebins, and wikis, JotBird links are readable, unlisted, and designed to be shared — not browsed. Noindex by default.

How it looks

Every published page gets a responsive URL — no ads, no tracking, no clutter, just your content. Markdown is rendered with proper typography, code blocks, headings, and lists. Here's an example.

Example of a published JotBird page showing rendered Markdown with headings, lists, and code blocks
Terminal

$ jotbird login

Open jotbird.com/account/api-key and paste your key.

Token: ••••••••••••

✓ Logged in successfully.

$ jotbird publish meeting-notes.md

✨ Published → share.jotbird.com/bright-calm-meadow

$ jotbird list

bright-calm-meadow Meeting Notes

share.jotbird.com/bright-calm-meadow

Ready to publish Markdown from the terminal?

Create a free JotBird account to get your API key and start publishing.

Reference

CLI Documentation

Everything you need to know about the JotBird CLI.

Setup

Installation

Install the JotBird CLI globally with npm. Requires Node.js 18 or later.

npm install -g jotbird

Verify the installation:

jotbird --version

Setup

Authentication

Link your JotBird account by running the login command. This is a one-time setup.

jotbird login

The CLI will open your browser to authenticate. Once you sign in, the CLI automatically receives your API key — no copy-pasting required.

Your token is stored locally on your machine. You won't need to log in again unless you revoke the key.

Command

Publish

Publish a new Markdown document or update an existing one. Free accounts get 90-day links. Pro makes links permanent.

jotbird publish meeting-notes.md

Supported file types: .md, .markdown, .mdx, .txt, .text, and files without an extension (e.g. README). You can also pipe any Markdown content via stdin (see below).

The CLI creates a .jotbird file in your working directory to track which files map to which published slugs. Running the same command again updates the existing document in place — same URL, fresh content.

# First publish → creates new document
jotbird publish README.md
✨ Published → share.jotbird.com/bright-calm-meadow

# Second publish → updates in place
jotbird publish README.md
✓ Updated → share.jotbird.com/bright-calm-meadow

Image uploads are not supported. Markdown image references (e.g. ![alt](url)) will render only if they point to externally-hosted images.

Command

List

View all your published documents.

jotbird list

bright-calm-meadow   Meeting Notes
                     share.jotbird.com/bright-calm-meadow

swift-red-fox        README
                     share.jotbird.com/swift-red-fox

Documents published via the CLI also appear in the web app, where you can view them and share the link. Editing is only available through the CLI — the web app shows CLI-published documents as read-only.

Command

Remove

Permanently delete a document from your account. This removes the public URL, stored content, and all associated data. You can pass either the original filename or the slug.

jotbird remove meeting-notes.md
jotbird remove bright-calm-meadow

Permanent action

This permanently deletes the document and link. There is no way to recover them.

Advanced

Piping from stdin

You can pipe Markdown directly into the CLI without a file. Useful for scripts and CI pipelines.

cat notes.md | jotbird publish

echo "# Quick note" | jotbird publish

When publishing from stdin, the CLI won't track a file mapping — each publish creates a new document.

The JotBird CLI is open source. View on GitHub