Skip to content

AI-powered CLI tool that automatically extracts metadata from web pages and adds them as intelligently organized bookmarks to your Pinboard account.

License

Notifications You must be signed in to change notification settings

kevinmcmahon/smartpin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

23 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š smartpin (pinit CLI)

Python License Version

AI-powered Pinboard bookmark manager with cloud-first storage and optional local database

smartpin installs the CLI tool pinit, which intelligently analyzes web pages and automatically saves bookmarks directly to your Pinboard.in account. By default, bookmarks are stored in the cloud via Pinboard's API for instant access anywhere. Optionally, you can maintain a local SQLite database for offline access and advanced bookmark management using the pinboard-tools library. Just provide a URL, and AI will extract the title, generate a concise description, and suggest relevant tags - no manual data entry required! πŸ€–βœ¨

✨ Features

  • πŸ€– Automatic metadata extraction - AI analyzes pages to extract title, description, and relevant tags
  • 🎯 Smart tagging - AI suggests contextually appropriate tags for better organization
  • πŸ”„ Flexible AI models - Supports Claude, OpenAI, Gemini, and other LLM providers
  • ☁️ Cloud-first storage - Bookmarks saved directly to Pinboard.in for instant access anywhere
  • πŸ—„οΈ Optional local database - Offline access and advanced bookmark management via pinboard-tools
  • πŸ”„ Bidirectional sync - Keep local database and Pinboard.in perfectly synchronized
  • 🌐 Reliable content fetching - Local HTTP client with BeautifulSoup for robust page parsing
  • πŸ’» Rich terminal UI - Beautiful output with progress indicators and formatted results
  • πŸ§ͺ Dry-run mode - Preview extractions and sync operations without making changes
  • πŸ“Š JSON output - Machine-readable format for scripting and automation
  • πŸ”’ Privacy controls - Mark bookmarks as private or "to read" as needed
  • 🏷️ Advanced tag management - Tag similarity detection and consolidation (via pinboard-tools)

πŸš€ Quick Start

Installation

# Clone the repository
git clone https://github.com/kevinmcmahon/smartpin.git
cd smartpin

# Install with uv (recommended)
uv pip install -e .

# Or install all dependencies
uv sync

Configuration

1. Get your Pinboard API token:

Visit https://pinboard.in/settings/password to find your API token.

2. Set up environment variables:

# Required: Pinboard authentication
export PINBOARD_API_TOKEN=your_username:your_token

# Required: AI provider API key (choose one based on your model)
export ANTHROPIC_API_KEY=your_key  # For Claude models
# OR
export OPENAI_API_KEY=your_key     # For GPT models
# OR see LLM docs for other providers

3. Optional: Create a .env file for persistent configuration:

# Create in project directory as .env or at ~/.pinit/config
PINBOARD_API_TOKEN=your_username:your_token

# Choose your AI provider (set the appropriate key)
ANTHROPIC_API_KEY=your_anthropic_api_key  # For Claude models
# OPENAI_API_KEY=your_openai_api_key     # For GPT models

# Optional: specify model (defaults to claude-opus-4.5)
PINIT_MODEL=gpt-5  # or claude-opus-4.5, gpt-4.1, etc.

Basic Usage

# Add a bookmark with AI analysis (saves directly to Pinboard.in)
pinit add https://example.com

# Preview extraction without saving
pinit add https://example.com --dry-run

# Add private bookmark marked as "to read"
pinit add https://example.com --private --toread

# Sync all bookmarks between local database and Pinboard (optional)
pinit sync

# Get JSON output for scripting
pinit add https://example.com --json

πŸ“– Usage Examples

Standard Bookmark Addition

pinit add https://example.com/ai-software-development

Output:

β”Œβ”€ Extracted Bookmark ─────────────────────────────────┐
β”‚ Title: How to Build Better Software with AI          β”‚
β”‚ URL: https://example.com/ai-software-development      β”‚
β”‚ Description: A comprehensive guide exploring how     β”‚
β”‚ artificial intelligence can enhance software         β”‚
β”‚ development workflows and code quality.              β”‚
β”‚ Tags: ai, software-development, programming, guide   β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

βœ“ Bookmark saved to Pinboard.in successfully!

Database Sync Operations

# Perform full bidirectional sync
pinit sync

# Preview sync operations without making changes
pinit sync --dry-run

# Check sync status and local database location
pinit config

Advanced Options

# Use a different AI model
pinit add https://example.com --model gpt-5

# Or use gpt-4.1-nano for faster/cheaper processing
pinit add https://example.com --model gpt-4.1-nano

# Check your configuration and database location
pinit config

# JSON output for automation
pinit add https://example.com --json | jq '.tags'

πŸ”§ Configuration

Configuration Loading

Configuration is loaded in this priority order (highest to lowest):

  1. System environment variables
  2. Local .env file (current directory)
  3. User configuration ~/.pinit/config

Local Database (Optional)

The application can optionally maintain a local SQLite database at ~/.pinit/bookmarks.db when using the pinit sync command. This local database:

  • Provides offline access to your bookmarks
  • Enables bidirectional sync with Pinboard.in
  • Supports advanced features like tag similarity detection and consolidation
  • Automatically initializes when you first run pinit sync
  • Works seamlessly with the pinboard-tools ecosystem

Note: The pinit add command saves bookmarks directly to Pinboard.in and does not use the local database. Only the pinit sync command creates and maintains the local database.

AI Model Configuration

The application uses the LLM library for flexible AI model integration:

  • Default model: claude-opus-4.5 (can be changed via PINIT_MODEL)
  • Supported providers: Anthropic Claude, OpenAI GPT, Google Gemini, and many others
  • Easy model switching: Change models without code modifications
  • Required API keys depend on your chosen provider:
    • ANTHROPIC_API_KEY for Claude models
    • OPENAI_API_KEY for GPT models
    • GEMINI_API_KEY for Google Gemini
    • See LLM documentation for other providers

Supported Models

Provider Popular Models Environment Variable
OpenAI gpt-5, gpt-4.5-preview, o4-mini, o3, gpt-4.1 OPENAI_API_KEY
Anthropic claude-opus-4.5, claude-sonnet-4.5, claude-opus-4.1, claude-haiku-4.5 ANTHROPIC_API_KEY
Google gemini-3-pro-preview, gemini-2.5-pro, gemini-2.5-flash, gemini-2.5-flash-lite GEMINI_API_KEY
Others Various See LLM docs

Choose the model that best fits your needs:

  • Speed: gpt-4.1-nano, claude-haiku-4.5, gemini-2.5-flash-lite
  • Quality: gpt-5, claude-opus-4.5, gemini-3-pro-preview
  • Cost: gpt-4.1-nano, claude-haiku-4.5, gemini-2.5-flash-lite

πŸ› οΈ Development

Setup Development Environment

# Install development dependencies
make dev

# Run all quality checks
make check

# Individual commands
make lint      # Run Ruff linting
make typecheck # Run MyPy type checking
make format    # Auto-format code
make clean     # Remove cache files

Architecture

smartpin installs the CLI tool pinit, which follows modern Python best practices with:

  • Type hints throughout the codebase
  • Comprehensive error handling with user-friendly messages
  • Clean separation of concerns between CLI, AI processing, and API interactions
  • Rich terminal formatting for beautiful output
  • Configurable AI models via the LLM library abstraction

Core Components

  • PinboardBookmarkExtractor - Interfaces with AI models to analyze web pages
  • pinboard_client - Wrapper functions for Pinboard API operations and sync management
  • cli - Click-based command interface with Rich formatting
  • Local SQLite database - Managed via pinboard-tools for advanced bookmark operations
  • Bidirectional sync - Keeps local and remote bookmarks synchronized
  • Jinja2 templates - Customizable prompts for AI extraction

πŸ“¦ Dependencies

Core Libraries

  • CLI Framework: click - Command-line interface creation
  • Terminal UI: rich - Beautiful terminal formatting
  • AI Integration: llm - Universal LLM library for multiple providers
  • Bookmark Management: pinboard-tools - Local database and sync capabilities
  • API Client: pinboard - Official Pinboard API client for direct operations
  • Configuration: python-dotenv - Environment variable management
  • Templating: jinja2 - Prompt template rendering

Key Features Enabled by Dependencies

  • pinboard-tools: Local SQLite database, bidirectional sync, advanced bookmark management
  • llm: Support for Claude, OpenAI, Gemini, and other AI providers
  • rich: Beautiful terminal output with progress indicators and formatting

🀝 Contributing

Contributions are welcome! Please:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Run quality checks (make check)
  4. Commit your changes (git commit -m 'Add amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

πŸ“„ License

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

πŸ™ Acknowledgments


About

AI-powered CLI tool that automatically extracts metadata from web pages and adds them as intelligently organized bookmarks to your Pinboard account.

Resources

License

Stars

Watchers

Forks

Packages

No packages published