Skip to main content

Classify bash commands as READONLY, WRITE, DANGEROUS, or UNKNOWN

Project description

bash-classify

Classify bash commands by their side-effect risk level.

What it does

bash-classify parses bash expressions using tree-sitter, classifies each command against a database of 120+ known commands, and outputs a structured JSON verdict. Commands are classified into four levels: READONLY, WRITE, DANGEROUS, and UNKNOWN.

Designed primarily as a Claude Code hook to automatically allow safe, read-only commands while flagging risky ones for human review.

Installation

uv tool install bash-classify
# or
pip install bash-classify

Quick start

$ echo 'kubectl get pods -n production' | bash-classify | jq '.classification'
"READONLY"

$ echo 'git push --force origin main' | bash-classify | jq '.classification'
"DANGEROUS"

$ echo 'cp file.txt /etc/config' | bash-classify | jq '.classification'
"DANGEROUS"

$ echo 'find . -name "*.pyc" -delete' | bash-classify | jq '.classification'
"DANGEROUS"

Claude Code plugin

The repo includes a Claude Code plugin that auto-allows readonly bash commands via a PreToolUse hook.

# Install the bash-classify CLI
uv tool install bash-classify

# Add the marketplace and install the plugin
claude plugin marketplace add fprochazka/bash-classify
claude plugin install bash-classify-hook@fprochazka-bash-classify

To upgrade after a new release:

uv tool upgrade bash-classify
claude plugin marketplace update fprochazka-bash-classify
claude plugin update bash-classify-hook@fprochazka-bash-classify

Once installed, any Bash tool call classified as READONLY is auto-approved — no permission prompt. Everything else (WRITE, DANGEROUS, UNKNOWN) still requires confirmation.

Command database

The classification database includes 120+ command definitions covering common Unix utilities, package managers, container tools, cloud CLIs, and more.

Classification levels

Level Description Examples
READONLY No side effects, safe to auto-approve ls, cat, grep, kubectl get
WRITE Modifies local files or state mkdir, cp, git commit
DANGEROUS Destructive, system-wide, or irreversible rm -rf, git push --force, chmod
UNKNOWN Command not in database Any unrecognized command

How it works

  • Tree-sitter parsing -- bash expressions are parsed into an AST for accurate command extraction, handling pipes, subshells, and command substitution
  • YAML command database -- each command has classification rules with subcommand and option matching
  • Subcommand matching -- kubectl get and kubectl delete can have different classifications
  • Delegation for wrappers -- commands like xargs, sudo, and env delegate classification to the inner command

Python API

from bash_classify import classify_expression

result = classify_expression("kubectl get pods")
print(result.classification)  # Classification.READONLY

See SPEC.md for the full specification.

Development

git clone https://github.com/fprochazka/bash-classify.git
cd bash-classify
uv sync --dev

Run tests and linting before committing:

uv run ruff format .
uv run ruff check .
uv run pytest

To add or modify command definitions, see docs/classification-guidance.md. All YAML files in src/bash_classify/commands/ are validated against a JSON Schema — your IDE will provide autocomplete if it supports the # $schema: comment.

Releasing

Version is derived automatically from git tags via hatch-vcs — no manual version bumping needed.

Before tagging, bump the version in both plugin manifest files:

  • coding-agent-plugins/claude-code/.claude-plugin/plugin.json
  • .claude-plugin/marketplace.json

Then tag and push:

git tag v<version>
git push origin v<version>

The publish.yml GitHub Action builds and publishes to PyPI automatically via trusted publishing.

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

bash_classify-0.1.2.tar.gz (89.8 kB view details)

Uploaded Source

Built Distribution

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

bash_classify-0.1.2-py3-none-any.whl (66.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bash_classify-0.1.2.tar.gz
Algorithm Hash digest
SHA256 313d6037d5c7aa09d1b9bddf78cd7db4207a0a4e0b9b8adcc365367718422ffc
MD5 5d92fd7eb3aef15dee82372d5aa27567
BLAKE2b-256 14c992e23505f4b54631771b7b7da96a26f7e92e60c05e0ff2d873d55991b583

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on fprochazka/bash-classify

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

File details

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

File metadata

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

File hashes

Hashes for bash_classify-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5709df4620e4a9c51402f6e7cd45a4a536a2a137982d5fc18a3a14c0d3de608e
MD5 56270aadc4817aff2158810dd578ec26
BLAKE2b-256 e6e37f210e5101451401fe5bdeac8c2f8b2882c5e9fdcdb008400b8941958060

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on fprochazka/bash-classify

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