Skip to main content

Analyze CLI tools against clig.dev guidelines

Project description

cliqa

Analyze CLI tools against clig.dev guidelines.

Installation

uv tool install cliqa
# or
pip install cliqa

Usage

Analyze any CLI command:

clint analyze ls
clint analyze git
clint analyze your-cli-tool

Run specific checks:

clint check ls help
clint check git version

List all available checks:

clint list-checks

Features

  • No mocking: Real integration tests with actual CLI commands
  • 93% test coverage: Comprehensive test suite
  • NASA05 compliance: Defensive assertions throughout
  • clig.dev alignment: Checks against modern CLI best practices

Pre-commit Hook

Add to your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/benomahony/cliqa
    rev: v0.1.1
    hooks:
      - id: cliqa
        args: [your-cli-tool]

Analyze multiple commands:

repos:
  - repo: https://github.com/benomahony/cliqa
    rev: v0.1.1
    hooks:
      - id: cliqa
        name: Check main CLI
        args: [my-tool]
      - id: cliqa
        name: Check admin CLI
        args: [my-admin-tool]

Enable AI-powered analysis:

repos:
  - repo: https://github.com/benomahony/cliqa
    rev: v0.1.1
    hooks:
      - id: cliqa
        args: [your-cli-tool, --ai]

This will analyze your CLI tool before each commit and fail if any errors are found.

Development

# Install dependencies
uv sync --extra test

# Run tests
uv run pytest

# Run pre-commit checks
pre-commit run --all-files

License

MIT

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

cliqa-0.1.2.tar.gz (171.2 kB view details)

Uploaded Source

Built Distribution

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

cliqa-0.1.2-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file cliqa-0.1.2.tar.gz.

File metadata

  • Download URL: cliqa-0.1.2.tar.gz
  • Upload date:
  • Size: 171.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cliqa-0.1.2.tar.gz
Algorithm Hash digest
SHA256 91f33130026b32c6ea95ae2fe46a83b5a7dc1c9cc5e4228c2584dcf37b7208ac
MD5 0bc9ba19e28306f0cc213c1d68dab83f
BLAKE2b-256 74e4377cf3609474df91986913a3a1b42e8749b230180dfc676438d5392f987d

See more details on using hashes here.

Provenance

The following attestation bundles were made for cliqa-0.1.2.tar.gz:

Publisher: publish.yml on benomahony/cliqa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cliqa-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: cliqa-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cliqa-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bd8a17b7fd7ec686b740b04583792125ab1067244beb12c1f04d87ef364dda41
MD5 6915ff6062cf9b0a1635fbd1ce76be96
BLAKE2b-256 a57f3c72ccecb8697f2bbcd2310a4ee561c6902952cfe9234678eb1acf2a0ffa

See more details on using hashes here.

Provenance

The following attestation bundles were made for cliqa-0.1.2-py3-none-any.whl:

Publisher: publish.yml on benomahony/cliqa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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