Skip to main content

Write type-annotated Python functions, get a CLI with argparse's native `--help` — no magic, no bloat. Flat commands only, synchronous execution

Project description

argss — Stupidly Simple CLI builder (sync-only, no groups)

Python PyPI License Platform Ruff

argss is a lightweight fork of arg-kiss — stripped down to the essentials.

Write type-annotated Python functions, get a CLI with argparse's native --help — no magic, no bloat. Flat commands only, synchronous execution.

🎯 Why argss?

Feature arg-kiss argss
@cli.command()
@cli.argument()
Type inference
Boolean flags
Global arguments
Command groups
Async support
color parameter (Python 3.14+ coloured help)
Dependencies none none

Use argss when you want:

  • Minimal code footprint
  • No asyncio overhead
  • Flat command structure (no sub-subcommands)
  • Faster import time (~30% faster than arg-kiss)

🚀 Quick Start

pip install argss
from argss import Argss

cli = Argss(name="todo", description="Task manager")

@cli.command()
def add(task: str, priority: int = 1, done: bool = False):
    """Add a task."""
    status = "✓" if done else "○"
    print(f"[{status}] {task} (priority: {priority})")

@cli.command()
def list_all():
    """Show all tasks."""
    print("Nothing yet!")

cli.run()
$ python todo.py add "Buy milk" --priority 2
[] Buy milk (priority: 2)

$ python todo.py list-all
Nothing yet!

$ python todo.py --help
usage: todo [-h] {add,list-all} ...

Task manager

positional arguments:
  {add,list-all}
    add           Add a task.
    list-all      Show all tasks.

options:
  -h, --help      show this help message and exit

📋 Commands & Features

@cli.command() — Define commands from functions

@cli.command()
def fetch(url: str, retries: int = 3):
    """Download from URL with retries"""
    print(f"Fetched {url} (retries: {retries})")

@cli.argument() — Customize argument flags

Use @cli.argument() above @cli.command() to customize flags, help text, and behavior for individual parameters.

@cli.argument("-u", "--user", help="Username")
@cli.argument(
    ["-p", "--port", {"help": "Port number", "type": int, "default": 8080}],
    ["--ssl", {"help": "Enable SSL", "action": "store_true"}]
)
@cli.command()
def connect(user: str, port: int = 8080, ssl: bool = False):
    """Connect to server"""
    print(f"Connecting as {user} on port {port} (SSL: {ssl})")

Type → CLI mapping

Function signature CLI argument
name: str Positional name
count: int = 1 --count 1
verbose: bool = False --verbose / --no-verbose
mode: str | None = None --mode MODE

Global arguments (apply to all commands)

cli.add_global_argument("--verbose", "-v", action="store_true", help="Verbose output")
cli.add_global_argument("--config", "-c", type=str, help="Config file path")

@cli.command()
def deploy(environment: str):
    """Deploy to environment."""
    # Global arguments available in parsed namespace
    pass

🎨 CLI Configuration

cli = Argss(
    name="mycli",                       # Program name (default: None)
    description="Does amazing things",  # Description in help (default: None)
    version="2.0.0",                    # Adds --version flag (default: None)
)
Option Description
name Program name in help (default: None)
description Description in help (default: None)
version Adds --version flag (default: None)

📄 License & Acknowledgments

MIT License — Built with Python standard library:

Module Purpose
argparse CLI parsing engine
inspect Signature introspection

Forked from: arg-kiss by Fkernel653

argss author: Fkernel653

Project: GitHubPyPI

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

argss-0.2.0.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

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

argss-0.2.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file argss-0.2.0.tar.gz.

File metadata

  • Download URL: argss-0.2.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for argss-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e3e1dcb614db13873870959b4f9a3c278cf201fd0b4936b63cb1c63a8dabd0ad
MD5 970c20e46648f19ab5a3823bc28909ea
BLAKE2b-256 d89fd347f8c6ad7edcca73219924b1b6dd21081f4ddf1e13d684ecdd21421335

See more details on using hashes here.

File details

Details for the file argss-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: argss-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for argss-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0898d1966ba39c0ad99633d19b7898d93ac0d5e644907b7a6087220d933f95c9
MD5 3b7349b496f5c7371588b2d99a433526
BLAKE2b-256 364c44d3a41b3c5509a656b34af6203ef097ed7864a27251e0e99242677dbe83

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