Skip to content

jonhadfield/sn-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

406 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ sn-cli

A modern command-line interface for Standard Notes

Build Status Go Report Card License: MIT

✨ Features

  • πŸ“‹ Notes & Tasks: Create, edit, and manage notes and checklists
  • 🏷️ Tags: Organize content with flexible tagging
  • πŸ“Š Statistics: Detailed analytics about your notes and usage
  • πŸ” Secure Sessions: Keychain integration for macOS and Linux
  • ⚑ Fast Sync: Efficient synchronization with Standard Notes servers
  • πŸ”„ Multi-Platform: Windows, macOS, and Linux support

πŸš€ Quick Start

Installation

Download the latest release:

# macOS/Linux
curl -L https://github.com/jonhadfield/sn-cli/releases/latest/download/sncli_$(uname -s)_$(uname -m) -o sn
chmod +x sn && sudo mv sn /usr/local/bin/

# Or via direct download
# Visit: https://github.com/jonhadfield/sn-cli/releases

First Run

# See all available commands
sn --help

# Add a note
sn add note --title "My First Note" --text "Hello, Standard Notes!"

# List your notes
sn get notes

# View statistics
sn stats

πŸ“‹ Commands

Command Description
add Add notes, tags, or tasks
delete Delete items by title or UUID
edit Edit existing notes
get Retrieve notes, tags, or tasks
tag Manage tags and tagging
task Manage checklists and advanced checklists
stats Display detailed statistics
session Manage stored sessions
register Register a new Standard Notes account
resync Refresh local cache
wipe Delete all notes and tags

Note: Export and import are temporarily disabled due to recent Standard Notes API changes

πŸ” Authentication

Environment Variables

export SN_EMAIL="your-email@example.com"
export SN_PASSWORD="your-password"
export SN_SERVER="https://api.standardnotes.com"  # Optional for self-hosted

Session Storage (Recommended)

Store encrypted sessions in your system keychain:

# Add session (supports 2FA)
sn session --add

# Add encrypted session
sn session --add --session-key

# Use session automatically
export SN_USE_SESSION=true
# or
sn --use-session get notes

πŸ†• Recent Updates

Version 0.4.1 (2026-01-30)

  • πŸ” Fixed: Authentication issues with updated dependencies
  • 🏷️ Improved: Tag cloud visualization with offline support
  • πŸ›‘οΈ Enhanced: Network error handling and graceful degradation
  • πŸ› Fixed: Tag reference matching and display issues

Version 0.4.0 (2026-01-29)

  • πŸ’Ύ Added: Backup and restore functionality
  • πŸ“€ Added: Enhanced export with multiple formats
  • 🎨 Added: Tag cloud visualization
  • πŸ“ Added: Note templates system

View full changelog β†’

πŸ’‘ Examples

# Create a note with tags
sn add note --title "Meeting Notes" --text "Important discussion points" --tag work,meetings

# Find notes by tag
sn get notes --tag work

# Create a checklist
sn add task --title "Todo List" --text "- Buy groceries\n- Call dentist\n- Finish project"

# View your note statistics
sn stats

# Edit a note
sn edit note --title "Meeting Notes" --text "Updated content"

βš™οΈ Advanced Configuration

Shell Completion

Tab completion is available for Bash, Zsh, Fish, and PowerShell.

Quick Install (Bash on macOS):

brew install bash-completion@2
sudo cp autocomplete/bash_autocomplete /usr/local/etc/bash_completion.d/sncli
echo '[ -f /usr/local/etc/bash_completion ] && . /usr/local/etc/bash_completion' >> ~/.bash_profile
source ~/.bash_profile

Quick Install (Fish):

mkdir -p ~/.config/fish/completions
cp autocomplete/fish_autocomplete.fish ~/.config/fish/completions/sncli.fish

πŸ“– For detailed installation instructions for all shells, see autocomplete/README.md

Self-Hosted Servers

export SN_SERVER="https://your-standardnotes-server.com"

πŸ”§ Development

# Build from source
git clone https://github.com/jonhadfield/sn-cli.git
cd sn-cli
make build

# Run tests
make test

# View all make targets
make help

⚠️ Known Issues

  • New accounts registered via sn-cli require initial login through the official web/desktop app to initialize encryption keys

🀝 Contributing

Contributions are welcome! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ”— Links


About

a command line interface for standard notes

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 7

Languages