• Rust and Cargo
• A Notion account
• Notion integration token
• Configured Notion database

Unix-like Systems (Linux/macOS)

Local User Installation

# Create local bin directory if it doesn't exist
mkdir -p ~/.local/bin

# Copy the binary
cp target/release/notion-cli-rs ~/.local/bin/

# Add to PATH in your shell's configuration file:

# For Bash (add to ~/.bashrc or ~/.bash_profile)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# For Zsh (add to ~/.zshrc)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

# For Fish (recommended way)
fish_add_path ~/.local/bin

System-wide Installation

# Requires sudo privileges
sudo cp target/release/notion-cli-rs /usr/local/bin/

Windows Installation

Manual Installation

# Create a directory for the binary
mkdir -p "$env:USERPROFILE\bin"

# Copy the binary
copy "target\release\notion-cli-rs.exe" "$env:USERPROFILE\bin"

# Add to PATH in PowerShell (current session)
$env:PATH += ";$env:USERPROFILE\bin"

# Add to PATH permanently (run in PowerShell as Administrator)
[Environment]::SetEnvironmentVariable(
    "Path",
    [Environment]::GetEnvironmentVariable("Path", "User") + ";$env:USERPROFILE\bin",
    "User"
)

Using Scoop

# Install Scoop if not already installed
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex

# Create and switch to a new directory for the package
mkdir ~/.scoop/apps/notion-cli-rs
cd ~/.scoop/apps/notion-cli-rs

# Copy the binary
copy "target\release\notion-cli-rs.exe" "notion-cli-rs.exe"

# Add to Scoop's shims
scoop shim add notion-cli-rs

1. Visit Notion Integrations
2. Click "New integration"
3. Configure capabilities:
   • ✅ Read content
   • ✅ Update content
   • ✅ Insert content
   • ✅ Delete content
4. Copy the Integration Token

Create a database with these properties:

cp .env.example .env

NOTION_TOKEN=secret_your_integration_token_here
NOTION_DATABASE_ID=your_database_id_here
LOCAL_TIMEZONE=America/New_York

Usage Guide

Basic Task Management

# Add a simple task
notion-cli-rs add "Buy groceries"

# Add a detailed task
notion-cli-rs add "Quarterly report" \
  --priority high \
  --due "2024-01-20" \
  --tags "work,reports,q4" \
  --description "Prepare Q4 2023 financial report for stakeholders"

# List all tasks
notion-cli-rs list

# List tasks with filters
notion-cli-rs list --status "in progress" --priority high

# Update task status
notion-cli-rs status <task-id> "in progress"
notion-cli-rs status <task-id> "done"

# Delete a task
notion-cli-rs delete <task-id>

Advanced Task Management

# Set/update task priority
notion-cli-rs priority <task-id> high

# Set/update due date
notion-cli-rs due-date <task-id> "2024-01-20"

# Add/update tags
notion-cli-rs tags <task-id> "urgent,priority,q4"

# Set/update description
notion-cli-rs description <task-id> "Detailed task description here"

Filtering and Sorting

# List high priority tasks
notion-cli-rs list --priority high

# List in-progress tasks
notion-cli-rs list --status "in progress"

# List tasks with specific tag
notion-cli-rs list --tag work

# List tasks sorted by due date
notion-cli-rs list --sort-by-due

Getting Help

# Show general help
notion-cli-rs --help

# Show help for specific command
notion-cli-rs add --help
notion-cli-rs list --help
# etc.

Common Issues:

1. Authentication Error:

   • Verify your NOTION_TOKEN in .env
   • Ensure the token starts with secret_
   • Check if the integration has access to the database

2. Database Not Found:

   • Verify your NOTION_DATABASE_ID in .env
   • Ensure the integration is connected to the database
   • Check if the database structure matches the requirements

3. Command Not Found:

   • If you haven't added the binary to PATH, use cargo run -- <command> instead of direct binary calls
   • Ensure you're in the project directory when using cargo run

4. Invalid Property Values:

   • Status must be exactly: "Not started", "In progress", or "Done"
   • Priority must be exactly: "High", "Medium", or "Low"
   • Due dates must be in YYYY-MM-DD format

Getting Help

# Show general help
notion-cli-rs --help

# Show help for specific command
notion-cli-rs add --help
notion-cli-rs list --help
# etc.

Running Tests

cargo test         # Run all tests
cargo test -- --nocapture  # With output

Building

cargo build --release