Luckynote CLI

Luckynote, from your terminal.

Search your library and save to it without leaving the shell. Built for developers, scripts, and AI agents.

curl -fsSL https://luckynote.io/cli/install.sh | sh

Requires Node.js 22 · Authenticate with a Luckynote API token

FIRST-TIME SETUP

Three steps. Then it stays out of your way.

1
Create a personal access token
In Luckynote, open Settings → API Tokens, name a new token “CLI”, then copy it when it appears. Tokens are shown only once.
2
Authenticate your terminal
luckynote auth --api-key <your-token>
3
Start using Luckynote
Your token is stored locally with restricted file permissions. Enable the token’s write option only if you want commands such as luckynote save to create notes.

luckynote

LUCKYNOTE

Luckynote CLI v0.1.0

$ luckynote search "auth retry logic" --json

{ "messages": [{ "title": "Auth retry notes", "folder": "Engineering" }] }

$ luckynote content <message-id> | llm "summarize this"

$ luckynote save "https://example.com/article"

YOUR LIBRARY, WHERE YOU WORK

Everything you can do from the shell.

Search your library

Find notes, links, and saved context by the detail you remember.

luckynote search "project plan"

Browse folders

List your library or resolve a folder path without opening the app.

luckynote folders --json

Read and pipe content

Print a saved note to pass it into another shell tool or agent.

luckynote content <message-id>

Save links and notes

Capture a URL or a thought at the moment you find it.

luckynote save "https://…"

Automate with JSON

Add --json to any command for scripts and agents.

luckynote search "plan" --json

Make the shell faster

Install completion for the commands you use every day.

luckynote completion zsh

Run luckynote --help in your terminal for the complete command reference and options.

CLI or MCP?

CLI is for people, scripts, and shell-capable agents. MCP connects Luckynote directly to tools such as Claude, Codex, Cursor, and ChatGPT through browser OAuth.

The CLI currently uses a personal access token from Settings → API Tokens. Browser login will be added without replacing the script-friendly token flow.