agentleFS
ai-assist-orgai-assist-org/ai-assist/CLAUDE.md

ai-assist

CLAUDE.md7 starsChanged 20 days agoApache-2.0View on GitHub

IMPORTANT: Read AGENTS.md before writing any code. It contains the project architecture, development guidelines, coding patterns, and examples that must be followed. Configured in .pre-commit-config.yaml: - black (formatting) - ruff (linting and import sorting) - mypy (type checking) - bandit (security linting) - pylint (duplicate code detection) - pytest (test suite with coverage ≥71%) - YAML/JSON/TOML syntax checks - Trailing whitespace removal Run pre-commit run --all-files before declaring a feature complete.

  • Installs packages

The file

We split this CLAUDE.md into the rules it gives an agent

4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run pre-commit run --all-files before declaring a feature complete.

    line 77
  2. Very specific:

    Test components individually: python -c "from ai_assist.module import ..."

    line 81
  3. Very specific:

    Check state: Inspect ~/.ai-assist/ directory contents

    line 82
  4. Very specific:

    Use --dev flag for code auto-reload during development

    line 84

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

IMPORTANT: Read AGENTS.md before writing any code. It contains the project architecture, development guidelines, coding patterns, and examples that must be followed.

Development Commands

Setup

# Install with dev dependencies
uv sync
# or: pip install -e ".[dev]"

# Setup pre-commit hooks
make pre-commit-install
# or: pre-commit install

Testing

make test                    # Run all tests (excludes integration, parallel with -n auto)
make test-cov                # Run tests with coverage report (≥71% required)
make test-fast               # Skip slow/integration tests
make test-integration        # Run sandbox integration tests (requires podman + built images)
pytest tests/test_file.py    # Run specific test file
pytest -v -s                 # Verbose with print output

Eval (agent behavior tests)

make test-eval               # Run eval suite with check judges only
make test-eval-full          # Run eval suite with LLM judges (slower, requires claude CLI)
uv run --extra eval python eval/run_eval.py --config eval/eval.yaml --model claude-sonnet-4-6 --cases jq-filter-json  # Single case

Code Quality

make format                  # Format with black and ruff (import sorting)
make lint                    # Lint with ruff
make lint-fix                # Auto-fix linting issues
make pre-commit-run          # Run all pre-commit hooks
make all-checks              # format-check + lint + test (CI mode)

Running the Application

uv run ai-assist                      # Interactive mode (default)
uv run ai-assist /monitor             # Start monitoring mode
uv run ai-assist /query "..."         # One-off query
uv run ai-assist /run workflow.awl    # Execute AWL workflow
uv run ai-assist --dev /interactive   # Enable code auto-reload (dev mode)

Service Management (Persistent Background Service)

ai-assist /service install           # Install as persistent service (default: ~/.ai-assist)
ai-assist /service install ~/.iris   # Install additional instance
ai-assist /service start|stop|restart|status <config_dir>
ai-assist /service enable|disable <config_dir>
ai-assist /service logs <config_dir> [-f]  # View logs (-f to follow)
ai-assist /service remove <config_dir>

Pre-commit Hooks

Configured in .pre-commit-config.yaml:

  • black (formatting)
  • ruff (linting and import sorting)
  • mypy (type checking)
  • bandit (security linting)
  • pylint (duplicate code detection)
  • pytest (test suite with coverage ≥71%)
  • YAML/JSON/TOML syntax checks
  • Trailing whitespace removal

Run pre-commit run --all-files before declaring a feature complete.

Debugging

  • Enable verbose logging: Set logging.basicConfig(level=logging.DEBUG) in code
  • Test components individually: python -c "from ai_assist.module import ..."
  • Check state: Inspect ~/.ai-assist/ directory contents
  • Monitor mode logs: Check console output or use systemd logs if running as service
  • Use --dev flag for code auto-reload during development

Important Notes

  • All tests must be green before any change (TDD baseline assumption)
  • No automatic truncation - tools support __save_to_file to handle large results
  • Security: Script execution is disabled by default. Only enable if you trust installed skills.
  • Extended context: 1M context window is native for Claude 4.6+ models (no opt-in needed)
  • JSON processing: __jq_filter parameter on any tool call for inline filtering; internal__json_query for processing saved files. Both require jq installed
  • Vertex AI users: For Claude 4.6+ models, use dateless IDs (e.g., claude-sonnet-4-6). The @YYYYMMDD format only applies to older models (e.g., claude-sonnet-4-5@20250929)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.