simkl-cli

CLI for Simkl.com - TV, Anime & Movie tracking.

Installation

# From npm (coming soon)
npm install -g simkl-cli

# Or with bun
bun install -g simkl-cli

Setup

1. Create an app at https://simkl.com/settings/developer/new
2. Configure the CLI with your client ID:

simkl config --client-id YOUR_CLIENT_ID

3. Authenticate using PIN code:

simkl auth
# Opens: https://simkl.com/pin
# Enter the code shown in CLI

Usage

Search

# Search all types
simkl search "Breaking Bad"

# Filter by type
simkl search "Inception" --type movie
simkl search "Attack on Titan" --type anime

# JSON output
simkl search "The Office" --json

Watchlist

# View your watchlist
simkl watchlist

# Filter by type
simkl watchlist --type shows

# Filter by status
simkl watchlist --status watching

Watch (Mark as Watched)

# Mark an episode as watched
simkl watch "Breaking Bad" 1x05
simkl watch "Breaking Bad" S01E05
simkl watch "Breaking Bad" 5

# Mark multiple episodes
simkl watch "Breaking Bad" 1x05,1x06,1x07
simkl watch "Breaking Bad" 1-5

# Mark a movie as watched
simkl watch "Dune" --movie

# Mark using ID directly
simkl watch --imdb tt1234567 1x01

Library Management

# Add to a list (plan to watch, watching, etc.)
simkl list --title "Dune" --movie --status plantowatch

# Add using IMDB ID
simkl list --imdb tt1234567 --status watching

# Remove episodes from watched history
simkl unwatch --title "Breaking Bad" --season 1 --episodes 5

Configuration

# Show current config
simkl config --show

# Show config file path
simkl config --path

Development

# Install dependencies
bun install

# Run in dev mode
bun run dev

# Build
bun run build

# Build standalone binary
bun run build:binary

# Regenerate API types from OpenAPI spec
bun run generate:types

API Types

TypeScript types are auto-generated from the Simkl API Blueprint spec using:

1. apib2swagger - Convert API Blueprint to OpenAPI 3.0
2. openapi-typescript - Generate TypeScript types from OpenAPI

License

MIT