Skip to main content

A CLI tool to help manage Frappe Docker instances.

Project description

Caffeinated Whale CLI

A command-line interface (CLI) for managing Frappe/ERPNext Docker instances during local development. Simplify container management, bench operations, and development workflows with an intuitive set of commands.

Features

  • Smart Port Management - Automatic port conflict detection and resolution
  • Project Discovery - Scan and list all Frappe Docker projects
  • Container Lifecycle - Start, stop, and restart projects with ease
  • Development Tools - VS Code integration, log viewing, and command execution
  • Cache System - Fast project inspection with SQLite-based caching and configuration storage
  • Default Site Support - Optional --site flag when default site is configured
  • Backup & Restore - Interactive site restoration with automatic file archive detection and P2P transfer support
  • Update Management - App updates with automatic migrations and lock cleanup
  • Auto-Inspection - Background process to keep project cache fresh automatically
  • System Integration - Auto-start on system boot with platform-specific configurations
  • Contextual Tips - Helpful tips displayed during long-running operations to help you discover features

Installation

Ensure you have Python 3.10+ and pip installed.

pip install caffeinated-whale-cli

Troubleshooting

After installation, if you see an error like 'cwcli' is not recognized..., the installation directory is not in your system's PATH.

To fix this:

  1. Find the script's location: Run pip show -f caffeinated-whale-cli and look for the location of cwcli.exe (or cwcli on macOS/Linux). It's typically in a Scripts or bin folder within your Python installation directory.
  2. Add to PATH: Follow your operating system's instructions to add this directory to your PATH environment variable.
  3. Restart your terminal: Close and reopen your terminal for changes to take effect.

Quick Start

# List all Frappe projects
cwcli ls

# Start a project (with automatic port conflict detection)
cwcli start my-project

# View bench logs in real-time
cwcli logs my-project

# Open project in VS Code
cwcli open my-project

# Update apps and migrate sites
cwcli update my-project --app erpnext --build

Command Reference

ls - List Projects

Scans Docker for Frappe/ERPNext projects and displays their status and ports.

cwcli ls [OPTIONS]

Options:

Option Description
-v, --verbose Display all ports individually, without condensing them into ranges
-q, --quiet Only display project names, one per line (useful for scripting)
--json Output the list of instances as a raw JSON string

Example Output:

┌──────────────┬─────────┬──────────────────┐
│ Project Name │ Status  │ Ports            │
├──────────────┼─────────┼──────────────────┤
│ frappe-one   │ running │ 8000-8005, 9000  │
│ frappe-two   │ exited  │                  │
└──────────────┴─────────┴──────────────────┘

start - Start Containers

Starts a project's containers with automatic port conflict detection and resolution.

cwcli start [OPTIONS] [PROJECT_NAME]...

Arguments:

Argument Description
PROJECT_NAME The name(s) of the Frappe project(s) to start (can be piped from stdin)

Options:

Option Description
-v, --verbose Enable verbose diagnostic output

Features:

  • Port Conflict Detection: Automatically checks if required ports are available
  • Interactive Resolution: Offers to stop conflicting Frappe projects
  • Process Identification: Shows which processes are using ports (cross-platform)
  • Smart Error Messages: Provides actionable guidance for resolution

Example:

# Start a single project
cwcli start frappe-one

# Start multiple projects
cwcli start frappe-one frappe-two

# Pipe from ls
cwcli ls --quiet | cwcli start

Port Conflict Example:

Warning: Some ports needed by 'frappe-one' are in use by other Frappe projects:
  • Project 'frappe-two': 8000-8005

? Stop project 'frappe-two' to free up its ports? (Y/n)

stop - Stop Containers

Stops a running project's containers.

cwcli stop [OPTIONS] [PROJECT_NAME]...

Arguments:

Argument Description
PROJECT_NAME The name(s) of the Frappe project(s) to stop (can be piped from stdin)

Options:

Option Description
-v, --verbose Enable verbose diagnostic output

Example:

# Stop a single project
cwcli stop frappe-one

# Stop multiple projects
cwcli stop frappe-one frappe-two

restart - Restart Containers

Restarts a project's containers and bench instance.

cwcli restart [OPTIONS] [PROJECT_NAME]...

Arguments:

Argument Description
PROJECT_NAME The name(s) of the Frappe project(s) to restart (can be piped from stdin)

Options:

Option Description
-v, --verbose Enable verbose diagnostic output

Example:

cwcli restart frappe-one

Example Output:

Attempting to restart 1 project(s)...
✓ Instance 'frappe-one' stopped.
✓ Instance 'frappe-one' started.
✓ Started bench (logs: /tmp/bench-frappe-one.log)
View logs with: cwcli logs frappe-one

logs - View Bench Logs

View bench logs in real-time from the log file inside the container.

cwcli logs [OPTIONS] PROJECT_NAME

Arguments:

Argument Description
PROJECT_NAME The name of the Frappe project to view logs for (required)

Options:

Option Description
-f, --follow / --no-follow Follow log output in real-time (default: follow)
-n, --lines INTEGER Number of lines to show from the end of the logs (default: 100)
-v, --verbose Enable verbose diagnostic output

Examples:

# Follow logs in real-time (default)
cwcli logs frappe-one

# Show last 50 lines and exit
cwcli logs frappe-one --no-follow --lines 50

# Show last 200 lines and follow
cwcli logs frappe-one -n 200

Note: Logs are stored at /tmp/bench-{project_name}.log inside the container.


inspect - Inspect Project Structure

Inspects a project to find all bench instances, sites, and apps within it. Results are cached for faster subsequent operations.

Security Note: The inspect command caches site configurations including database credentials and Redis URLs. The cache is stored with restricted filesystem permissions (directory: 0700, database: 0600) to prevent unauthorized access. Only the current user can read the cached data. Do not share the cache directory (~/.cwcli/cache/) with untrusted users.

cwcli inspect [OPTIONS] PROJECT_NAME

Arguments:

Argument Description
PROJECT_NAME The Docker Compose project to inspect (required)

Options:

Option Description
-v, --verbose Enable verbose diagnostic output
-j, --json Output the result as a JSON object
-u, --update Update the cache by re-inspecting the project
-a, --show-apps Show available apps in the output tree
-i, --interactive Prompt to name each bench instance interactively

What It Caches:

  • Bench instances and their paths
  • Sites and installed apps for each bench
  • Site configurations (database credentials, developer mode settings)
  • Common site configuration (Redis URLs, ports, default site, etc.)
  • Default site is labeled with (default) in output

Example Output:

frappe-one
├── Bench: bench
│   ├── Site: frappe-one.localhost (default)
│   │   ├── App: frappe (v15.0.0, develop)
│   │   └── App: erpnext (v15.0.0, version-15)
│   └── Site: site2.localhost
│       ├── App: frappe (v15.0.0, develop)
│       └── App: erpnext (v15.0.0, version-15)
└── Bench: bench2
    └── Site: site3.localhost
        └── App: frappe (v15.0.0, develop)

Benefits:

  • Enables default site feature: unlock command can omit --site flag
  • Faster subsequent operations (uses cached data)
  • Stores configurations for programmatic access

Examples:

# Inspect and cache project structure
cwcli inspect frappe-one

# Force refresh the cache
cwcli inspect frappe-one --update

# Show available apps
cwcli inspect frappe-one --show-apps

# Get JSON output
cwcli inspect frappe-one --json

# Interactive bench naming
cwcli inspect frappe-one --interactive

open - Open in VS Code or Docker Exec

Opens a project's frappe container in VS Code (with Dev Containers) or executes into it.

cwcli open [OPTIONS] PROJECT_NAME

Arguments:

Argument Description
PROJECT_NAME The Docker Compose project name to open (required)

Options:

Option Description
-p, --path TEXT Path inside the container to open (uses cached bench path from inspect if not specified)
-a, --app TEXT App name to open (opens the app's directory within the bench)
--code Open with VS Code directly (skips interactive prompt)
--code-insiders Open with VS Code Insiders directly (skips interactive prompt)
--docker Open with Docker exec directly (skips interactive prompt)
-v, --verbose Enable verbose diagnostic output

Features:

  • Auto-detects VS Code and VS Code Insiders installations
  • Interactive editor selection menu (when no editor flag specified)
  • Direct editor selection via --code, --code-insiders, or --docker flags
  • Automatically installs required VS Code extensions (Docker and Dev Containers)
  • Uses cached bench paths from inspect command
  • Docker exec opens in bench directory (respects working directory)
  • Falls back to Docker exec if VS Code is unavailable

Examples:

# Open project with interactive prompt (uses cached bench path)
cwcli open frappe-one

# Open directly with VS Code (skip prompt)
cwcli open frappe-one --code

# Open directly with Docker exec (skip prompt)
cwcli open frappe-one --docker

# Open specific app directory with VS Code Insiders
cwcli open frappe-one --app erpnext --code-insiders

# Open custom path
cwcli open frappe-one --path /workspace/custom-bench

Interactive Prompt:

When no editor flag is specified, you'll see:

How would you like to open this instance?
❯ VS Code - Open in development container
  Docker - Execute interactive shell in container

update - Update Apps and Migrate

Updates specified Frappe apps and migrates all sites where they are installed.

cwcli update [OPTIONS] PROJECT_NAME

Arguments:

Argument Description
PROJECT_NAME The name of the project to update (required)

Options:

Option Description
-a, --app TEXT App name(s) to update (specify multiple apps after --app or use --app multiple times)
-p, --path TEXT Path to the bench directory inside the container (uses cached path from inspect if not specified)
-v, --verbose Enable verbose output with streaming command execution
-c, --clear-cache Clear cache for all affected sites after migration
-w, --clear-website-cache Clear website cache for all affected sites after migration
-b, --build Build assets after updating apps

What It Does:

  1. Runs git pull in each specified app directory
  2. Identifies all sites where the updated apps are installed
  3. Runs bench --site <site> migrate for each affected site
  4. (Optional) Runs bench build --app <app> for successfully updated apps
  5. (Optional) Runs bench --site <site> clear-cache for affected sites
  6. (Optional) Runs bench --site <site> clear-website-cache for affected sites
  7. Automatically clears locks folder for all affected sites to prevent stale locks

Examples:

# Update a single app
cwcli update frappe-one --app erpnext

# Update multiple apps
cwcli update frappe-one --app frappe --app erpnext

# Update with build and cache clearing
cwcli update frappe-one --app erpnext --build --clear-cache --clear-website-cache

# Update with verbose output
cwcli update frappe-one --app custom_app -v

Example Output:

Updating project: frappe-one

Updating 1 app(s) for project 'frappe-one'

→ Updating app: erpnext
✓ Successfully updated 'erpnext'
  Found 2 site(s) with 'erpnext' installed

Migrating 2 affected site(s)

✓ Migration complete for all affected sites

✓ Successfully updated 1 app(s)

unlock - Unlock Site

Removes the locks folder for a specified site to unlock it.

cwcli unlock [OPTIONS] PROJECT_NAME

Arguments:

Argument Description
PROJECT_NAME The Docker Compose project name (required)

Options:

Option Description
-s, --site TEXT Site name to unlock. If not provided, uses the default site from common_site_config.json
-p, --path TEXT Path to the bench directory inside the container (uses cached path from inspect if not specified)
-v, --verbose Enable verbose output and stream rm command output

What It Does:

Removes the {bench_path}/sites/{site_name}/locks directory, which can help resolve issues when a site is stuck in a locked state due to incomplete migrations or background jobs.

Smart Defaults:

  • If --site is not specified, automatically uses the default site from your bench's common_site_config.json
  • Shows "Using default site: {site}" when using the default
  • Run cwcli inspect {project} first to cache the configuration

Examples:

# Unlock a specific site
cwcli unlock my-project --site development.localhost

# Use default site (no --site flag needed)
cwcli unlock my-project
# Output: Using default site: development.localhost

# Verbose mode with default site
cwcli unlock my-project -v

When to Use:

  • After a migration fails or is interrupted
  • When you see "This document is currently locked and queued for execution" errors
  • When background jobs don't complete properly

Examples:

# Unlock a site
cwcli unlock my-project --site development.localhost

# Unlock with verbose output to see files being removed
cwcli unlock my-project --site development.localhost -v

Example Output:

✓ Successfully unlocked site 'development.localhost'
Removed locks folder: /workspace/frappe-bench/sites/development.localhost/locks

Note: The update command automatically clears locks after completion, so manual unlocking is typically only needed for interrupted operations.


restore - Restore Site from Backup

Interactively restore a site from a backup with automatic detection of file archives and encryption keys. Supports both local restoration and peer-to-peer backup transfers via sendme.

cwcli restore [OPTIONS] PROJECT_NAME

Arguments:

Argument Description
PROJECT_NAME The Docker Compose project name (required)

Options:

Option Description
-s, --site TEXT Site name to restore. If not provided, uses the default site from common_site_config.json
-p, --path TEXT Path to the bench directory inside the container (uses cached path from inspect if not specified)
--mariadb-root-username TEXT MariaDB root username (default: root)
--mariadb-root-password TEXT MariaDB root password (will prompt if not provided)
--admin-password TEXT Set administrator password after restore
--send P2P Mode: Share backup with another machine via peer-to-peer transfer
--receive P2P Mode: Receive backup from another machine via peer-to-peer transfer
-v, --verbose Enable verbose output and show restore command details

What It Does:

  1. Scans all backup files across all sites in the bench
  2. Presents an interactive menu with backups grouped by target site
  3. Shows badges indicating backup contents: [FILES], [PRIVATE], [DATABASE ONLY]
  4. Automatically detects and restores public/private file archives
  5. Restores encryption key from backup's site_config if available
  6. Displays helpful error messages on failure with common causes

Interactive Features:

  • Smart Grouping: Backups from the target site shown first, followed by backups from other sites
  • Visual Badges: Clear indicators of what each backup contains
  • Secure Password Prompt: Uses questionary for consistent, secure password input
  • Confirmation Dialog: Warns about data replacement before restore
  • TipSpinner: Shows helpful tips during restore operation

Examples:

# Restore with interactive backup selection (uses default site)
cwcli restore my-project

# Restore specific site
cwcli restore my-project --site production.localhost

# Restore with verbose output for debugging
cwcli restore my-project -v

# Provide password via command line (not recommended for production)
cwcli restore my-project --mariadb-root-password "secret123"

Example Session:

Using default site: development.localhost

? Select a backup to restore: (Use arrow keys)

=== Backups from site: development.localhost ===
 > 2025-11-12 10:56:38  [FILES] [PRIVATE]
   2025-11-12 09:30:01  [DATABASE ONLY]
   2025-11-11 23:15:42  [FILES] [PRIVATE]

⚠ Warning: This will replace all data in site 'development.localhost'
Backup: 20251112_105638-development_localhost-database.sql.gz
From: 2025-11-12 10:56:38
Will restore: Database, Public files, Private files

? Are you sure you want to restore? (y/N) y
MariaDB root password: ********

✓ Successfully restored site 'development.localhost'
From backup: 20251112_105638-development_localhost-database.sql.gz
Including file archives
Updated encryption_key from backup site_config

P2P Backup Transfer:

Share backups between machines using peer-to-peer connections (powered by sendme/Iroh):

Sending a Backup:

# On the source machine
cwcli restore my-project --send

# Select backup from interactive menu
# Ticket automatically copied to clipboard Transfer ticket copied to clipboard!

Instructions for the receiver:
  1. Run: cwcli restore <project_name> --receive
  2. Paste the ticket when prompted

Receiving a Backup:

# On the destination machine
cwcli restore my-project --receive

# Paste the ticket from sender
? Enter the sendme ticket: blob...

# Files download with hash verification Files downloaded successfully
# Automatic restore process begins

P2P Transfer Features:

  • Hash-verified transfers - BLAKE3 cryptographic verification ensures data integrity
  • Resumable downloads - Interrupted transfers can resume from where they stopped
  • NAT traversal - Works behind firewalls and corporate networks
  • No cloud intermediary - Direct peer-to-peer connections
  • Cross-platform - Works on macOS, Linux, and Windows
  • Automatic setup - sendme binary auto-installed on first use
  • Multiple receivers - Same ticket can be used by multiple machines

Use Cases:

  • Share production backups with development team
  • Transfer large backups without cloud storage limits
  • Migrate data between data centers
  • Distribute backups to multiple environments simultaneously

Security:

  • Passwords validated to prevent shell injection
  • All inputs sanitized for command injection prevention
  • Backup file existence verified before restore
  • Passwords masked in verbose output
  • P2P transfers are hash-verified (BLAKE3) to prevent tampering
  • Treat transfer tickets like passwords (they grant download access)

When to Use:

  • Restore from scheduled backups after issues
  • Migrate data between environments
  • Recover from data corruption or accidental deletion
  • Test backup integrity
  • Share backups between machines without cloud storage

run - Execute Bench Commands

Executes bench commands inside a project's frappe container.

cwcli run [OPTIONS] PROJECT_NAME BENCH_ARGS...

Arguments:

Argument Description
PROJECT_NAME The Docker Compose project name (required)
BENCH_ARGS Bench command and arguments to run (required)

Options:

Option Description
-p, --path TEXT Path to the bench directory inside the container (default: /workspace/frappe-bench)
-v, --verbose Enable verbose output

Examples:

# Run bench migrate
cwcli run frappe-one migrate

# Run bench with specific site
cwcli run frappe-one --site development.localhost migrate

# Execute a custom bench command
cwcli run frappe-one console

# Use custom bench path
cwcli run frappe-one migrate --path /workspace/custom-bench

status - Check Health Status

Checks the health status of a Frappe project instance.

cwcli status [OPTIONS] PROJECT_NAME

Arguments:

Argument Description
PROJECT_NAME The Docker Compose project name to check (required)

Options:

Option Description
-v, --verbose Show the health-check command, raw curl output, and explain the reported status

Status Values:

  • offline - Container is not running
  • online - Container is running but HTTP probe failed
  • running - Container is running and HTTP probe succeeded

Example:

cwcli status frappe-one

config - Manage Configuration

Manages the CLI configuration and cache.

cwcli config [SUBCOMMAND]

Subcommands

config path - Show Config Path

Displays the path to the configuration file.

cwcli config path
config add-path - Add Custom Bench Path

Adds a custom bench search path to the configuration.

cwcli config add-path PATH

Arguments:

Argument Description
PATH The absolute path to add to the custom search paths (required)

Example:

cwcli config add-path /home/user/custom-bench
config remove-path - Remove Custom Bench Path

Removes a custom bench search path from the configuration.

cwcli config remove-path PATH

Arguments:

Argument Description
PATH The path to remove from the custom search paths (required)

Example:

cwcli config remove-path /home/user/custom-bench
config cache - Manage Cache

Manages the cache for project inspection data.

cwcli config cache [SUBCOMMAND]

Cache Subcommands:

  • clear [PROJECT_NAME] - Clear cache for a specific project or the entire cache

    • Options: -a, --all - Clear the entire cache
    • Example: cwcli config cache clear frappe-one
    • Example: cwcli config cache clear --all
  • path - Display the path to the cache file

    • Example: cwcli config cache path
  • list - List all projects currently in the cache

    • Example: cwcli config cache list
config auto-inspect - Automatic Project Inspection

Manages automatic background inspection of running Frappe projects to keep cached data fresh.

cwcli config auto-inspect [SUBCOMMAND]

Auto-Inspect Subcommands:

  • enable - Enable automatic project inspection

    • Options:
      • --interval INTEGER - Inspection interval in seconds (minimum 60, default 3600)
      • --startup - Also enable automatic startup on system boot/login
    • Example: cwcli config auto-inspect enable --interval 1800 --startup
  • disable - Disable automatic inspection and stop background process

    • Example: cwcli config auto-inspect disable
  • start - Start the auto-inspect background process

    • Options:
      • --startup - Also enable automatic startup on system boot
    • Example: cwcli config auto-inspect start --startup
  • stop - Stop the auto-inspect background process

    • Example: cwcli config auto-inspect stop
  • restart - Restart the auto-inspect background process

    • Example: cwcli config auto-inspect restart
  • status - Show detailed status (enabled, interval, process state, PID, startup)

    • Example: cwcli config auto-inspect status
  • logs - View recent background process logs

    • Options: --lines INTEGER - Number of log lines to show (default 20)
    • Example: cwcli config auto-inspect logs --lines 50
  • set-interval - Change the inspection interval

    • Example: cwcli config auto-inspect set-interval 7200
  • install-startup - Install platform-specific startup configuration

    • Creates LaunchAgent (macOS), systemd service (Linux), or Task Scheduler task (Windows)
    • Example: cwcli config auto-inspect install-startup
  • uninstall-startup - Remove startup configuration

    • Example: cwcli config auto-inspect uninstall-startup

What it does:

The auto-inspect feature runs a background daemon process that periodically inspects all running Frappe projects. This keeps your project cache fresh for:

  • Tab completion (project names, apps, sites)
config tips - Manage Contextual Tips

Control the display of helpful tips during long-running operations.

cwcli config tips [enable|disable|status]

Subcommands:

  • enable - Enable contextual tips during long operations

    • Example: cwcli config tips enable
  • disable - Disable contextual tips

    • Example: cwcli config tips disable
  • status - Show whether contextual tips are enabled

    • Example: cwcli config tips status

What it does:

When enabled (default), cwcli displays rotating helpful tips alongside spinners during long-running operations like inspect, update, and open. Tips help you discover features and best practices while waiting for operations to complete.

Examples of tips shown:

  • 💡 Add VS Code to PATH via Command Palette: 'Shell Command: Install code command in PATH'
  • 💡 Install tab completion with 'cwcli --install-completion' for faster workflows
  • 💡 Use 'cwcli inspect ' to cache project structure for faster commands
  • 💡 cwcli automatically detects and resolves port conflicts when starting projects
  • Project status queries
  • Other commands that rely on cached data

Quick Setup:

# Enable with 1-hour interval and auto-start on boot
cwcli config auto-inspect enable --interval 3600 --startup

# Start the background process
cwcli config auto-inspect start

# Check status
cwcli config auto-inspect status

# View logs
cwcli config auto-inspect logs

Notes:

  • Background process survives terminal closure
  • Process stops on system restart unless startup is enabled
  • Logs stored in ~/.cwcli/run/auto-inspect.log
  • PID file stored in ~/.cwcli/run/auto-inspect.pid

Tips and Tricks

Piping Commands

Many commands support piping project names from stdin:

# Start all projects
cwcli ls --quiet | cwcli start

# Stop specific projects using grep
cwcli ls --quiet | grep "frappe-" | cwcli stop

Scripting with JSON

Use JSON output for programmatic access:

# Get project data as JSON
cwcli ls --json | jq '.[] | select(.status=="running")'

# Parse inspect output
cwcli inspect frappe-one --json | jq '.benches[0].sites'

Verbose Mode for Debugging

Use -v flag on any command to see detailed diagnostic output:

cwcli start frappe-one -v
cwcli update frappe-one --app erpnext -v

Shell Completion

cwcli supports intelligent tab completion for project names, apps, and sites across all shells (Bash, Zsh, Fish, PowerShell).

One-time setup:

# Install completion for your current shell
cwcli --install-completion

# Restart your shell or source your shell config
source ~/.bashrc  # For Bash
source ~/.zshrc   # For Zsh

What gets completed:

  • Project names - All commands that accept project names (start, stop, restart, inspect, logs, open, status, run, update, unlock)
  • App names - Commands with --app option (open, update)
  • Site names - Commands with --site option (unlock)

Examples:

# Press TAB after typing partial project name
cwcli start frap<TAB>
# Completes to: cwcli start frappe-one

# Press TAB to see available apps for a project
cwcli update frappe-one --app <TAB>
# Shows: erpnext  frappe  hrms  custom_app

# Press TAB to see available sites
cwcli unlock frappe-one --site <TAB>
# Shows: site1.localhost  site2.localhost

How it works:

  • Projects: Queried from Docker containers in real-time
  • Apps/Sites: Loaded from cached project data (run cwcli inspect first)
  • Fast & Context-aware: Completions adapt based on the project specified

Troubleshooting:

If completion doesn't work:

  1. Ensure you've run cwcli --install-completion
  2. Restart your shell
  3. For apps/sites, run cwcli inspect <project> to populate the cache

Architecture

The CLI uses:

  • Docker SDK for Python - Container management
  • Typer - CLI framework with type hints
  • Rich - Terminal formatting and spinners
  • Questionary - Interactive prompts
  • Peewee ORM - SQLite-based caching

Data Directories:

  • Config: ~/.cwcli/config/ - Configuration files
  • Cache: ~/.cwcli/cache/cwc-cache.db - Project inspection cache
  • Runtime: ~/.cwcli/run/ - PID and log files for background services

License

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

Contributing

Contributions are welcome! Please see our Contributing Guide for detailed information.

Quick Links:

Getting Started:

# Clone the repository
git clone https://github.com/karotkriss/caffeinated-whale-cli.git
cd caffeinated-whale-cli

# Install dependencies
uv sync --all-extras

# Run tests
uv run pytest --cov

# Format and lint
uv run black src/ tests/
uv run ruff check src/ --fix

For questions or issues, please open an issue on GitHub.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

caffeinated_whale_cli-0.20.0.tar.gz (100.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

caffeinated_whale_cli-0.20.0-py3-none-any.whl (92.4 kB view details)

Uploaded Python 3

File details

Details for the file caffeinated_whale_cli-0.20.0.tar.gz.

File metadata

File hashes

Hashes for caffeinated_whale_cli-0.20.0.tar.gz
Algorithm Hash digest
SHA256 6f48dffb145c92c541d50e66fead95c80bf2384a9aea64c6b48646859ddc5e43
MD5 d6cb1ca2eab213b361fdb76a24a3185a
BLAKE2b-256 a56900263a804d273c76563aeda8ff0517212459796a0de616a6881b097bbd4a

See more details on using hashes here.

File details

Details for the file caffeinated_whale_cli-0.20.0-py3-none-any.whl.

File metadata

File hashes

Hashes for caffeinated_whale_cli-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cebbabc0e99befea999f4045c49e384ae938a9d7d74e73341db0810e56179055
MD5 d33b09dfddbf6e9e1117046498f9da41
BLAKE2b-256 d37d3d5c2a0d8b749fd098ce2cdfd799edf6dcab8b47e65271e0a079066e5964

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page