fastmd

package module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 3, 2026 License: MIT Imports: 1 Imported by: 0

README

fastmd.dev

Minimalist CLI-first Markdown hosting for developers and AI agents.

fastmd lets you push Markdown from terminal to a short URL in milliseconds. The same document can be consumed by humans as HTML and by machines as raw Markdown.

cat report.md | fastmd
# -> https://fastmd.dev/x7y2

Latest Update (v0.1.2)

  • Refined homepage SEO metadata (title, description, canonical, OG/Twitter cards, JSON-LD)
  • Added stricter indexation controls for document/detail responses
  • Added new use case: Instant Skill Report Sharing
  • Rebalanced Use Cases layout to a cleaner symmetric grid

Install

curl -fsSL https://fastmd.dev/install.sh | sh

Supported platforms:

  • macOS: arm64, amd64
  • Linux: arm64, amd64

Quick Start

Publish
# Pipe mode
cat report.md | fastmd

# File mode
fastmd push report.md
Pull raw markdown
fastmd get x7y2
Delete
fastmd delete x7y2
Upgrade
fastmd upgrade

Core Use Cases

  1. AI External Display Large agent output is published to a clean web view instead of flooding terminal history.

  2. Seamless Agent Handoff Use /:id.md to pass structured context between local and remote agents.

  3. Stealth Doc Sharing Share internal docs quickly while keeping distribution controlled.

  4. CI/CD Debug Snapshots Pipe failed build/test logs to a short URL for team debugging.

  5. Remote Prompt Control Host prompt/state markdown centrally and let remote workers pull updates.

  6. Instant Skill Report Sharing Pipe AI skill outputs (SEO audits, content drafts, reports) to fastmd and share a clean private link in milliseconds.


REST API

POST /v1/push
curl -X POST https://fastmd.dev/v1/push \
  -H "Content-Type: application/json" \
  -d '{"content":"# Hello\nWorld","token":"fmd_live_xxxx"}'

Response:

{"id":"x7y2","url":"https://fastmd.dev/x7y2"}
GET /:id

Human-friendly HTML view.

GET /:id.md

Raw Markdown view for agents and scripts.

DELETE /v1/:id
curl -X DELETE https://fastmd.dev/v1/x7y2 \
  -H "Authorization: Bearer fmd_live_xxxx"
GET /v1/version
curl https://fastmd.dev/v1/version

Token & Privacy Model

  • First run generates token like fmd_live_xxxx
  • Token is saved locally at ~/.config/fastmd/token
  • Server stores only token hash (SHA-256), never raw token
  • Token ownership controls delete permission
  • Detail/raw pages return no-index directives for privacy-first sharing

Self-Hosting

git clone https://github.com/wonfull888/fastmd.git
cd fastmd
make build-server
./dist/fastmd-server --port 8080 --db ./data/fastmd.db

Reverse proxy example (Caddy):

fastmd.yourdomain.com {
    reverse_proxy localhost:8080
}

Release

See:


License

MIT

Documentation

Index

Constants

This section is empty.

Variables

View Source
var InstallSH []byte

InstallSH embeds the install.sh script into the binary.

View Source
var WebFS embed.FS

WebFS embeds all web assets (templates + static files) into the binary.

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
cmd
cli command
server command
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL