Skip to content

bjarkehs/simkl-cli

Repository files navigation

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
  1. 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

Sync

# Add to watchlist
simkl sync add "Dune" --type movie --status plantowatch

# Add using IMDB ID
simkl sync add "Movie" --imdb tt1234567

# Add to watch history
simkl sync history "Blade Runner 2049" --type movie

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

About

CLI for Simkl.com - TV & movie tracking

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •