Skip to content

jotbirdhq/jotbird-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JotBird

Publish Markdown from the command line. Three commands to go from file to shareable link.

$ jotbird publish README.md
Published: https://share.jotbird.com/bright-calm-meadow

Every published page gets a responsive URL — no ads, no tracking, no clutter, just your content. Unlike gists, pastebins, and wikis, JotBird links are readable, unlisted, and designed to be shared — not browsed. Noindex by default.

Install

Requires Node.js 18+.

npm install -g jotbird

Quick start

# 1. Log in (one-time setup)
jotbird login

# 2. Publish a file
jotbird publish notes.md

# 3. Update it — same URL, fresh content
jotbird publish notes.md

Commands

Command Description
jotbird login Authenticate with your JotBird account
jotbird publish <file> Publish or update a Markdown file
jotbird publish --slug <slug> <file> Update a specific document by slug
jotbird publish Read Markdown from stdin
jotbird list List your published documents (also visible in the web app as read-only)
jotbird unpublish <file|slug> Take down the public URL (keeps document in account)
jotbird remove <file|slug> Permanently delete a document
jotbird help Show help

How it works

The CLI tracks file-to-slug mappings in a .jotbird file in your working directory. When you publish the same file again, it updates the existing document at the same URL.

$ jotbird publish README.md
Published: https://share.jotbird.com/bright-calm-meadow

$ jotbird publish README.md
Updated: https://share.jotbird.com/bright-calm-meadow

Pipe from stdin for scripts and CI:

cat notes.md | jotbird publish
echo "# Hello" | jotbird publish

When publishing from stdin, no file mapping is created — each publish creates a new document.

To update a specific document by slug — regardless of file tracking — use the --slug flag:

jotbird publish --slug bright-calm-meadow notes.md
echo "# Updated" | jotbird publish --slug bright-calm-meadow

Authentication

Run jotbird login to open your browser and authenticate. The CLI will automatically receive your API key once you sign in — no copy-pasting required. If the browser doesn't open, the CLI displays a URL to visit manually and falls back to a paste prompt.

The key is stored locally at ~/.config/jotbird/credentials with 0600 permissions.

Image uploads

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

Free vs Pro

Free Pro
Published links 90 days expiration Permanent
Active documents 10 Unlimited
Rate limit 10 publishes/hour 100 publishes/hour

Upgrade at jotbird.com/pro.

Links

License

MIT

About

Publish Markdown from the command line with JotBird

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published