feat: Add command-less CLI invocation and comprehensive agent integra… #76
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tion guide Implement command-less CLI invocation to make redlines more agent-friendly. Users can now invoke `redlines "source" "test"` directly without specifying a command, and it automatically outputs JSON (the most agent-friendly format). ## Key Changes ### CLI Enhancements - Add `compare` command as the default command using click-default-group - Command-less invocation: `redlines "source" "test"` outputs JSON by default - Support `--pretty` flag for human-readable JSON formatting - Smart TTY detection: helpful tip shows only in interactive terminals - Maintains backward compatibility with all existing commands (text, json, markdown, stats, guide) ### Dependencies - Add click-default-group (>=1.2.4) for robust default command handling ### Documentation - Add comprehensive AGENT_GUIDE.md with: - Quick start examples for AI agents and automation - Complete JSON schema reference - Decision matrix for choosing output formats - Performance guidelines and benchmarks - Real-world integration examples (CI/CD, pre-commit hooks, batch processing) - Error handling patterns - Update README.md with: - New "For AI Agents & Automation" section - Command-less CLI usage examples - Reorganized CLI documentation - Add Agent Guide URL to project metadata in pyproject.toml ### Examples - Add examples/ directory with runnable scripts: - compare_files.py: Basic file comparison - batch_diff.py: Batch processing multiple files - ci_check.py: CI/CD integration example - generate_report.py: HTML report generation - pre_commit_hook.sh: Git pre-commit hook ### Tests - Add comprehensive test suite for command-less invocation (9 new tests) - All 46 CLI tests passing - Tests verify JSON output, exit codes, file handling, UTF-8 support ## Benefits for AI Agents - Simpler invocation: `redlines "a" "b"` instead of `redlines json "a" "b"` - Structured JSON output by default (parseable, predictable) - Clean output when piped (tip message only appears in interactive terminals) - Comprehensive guide with copy-paste ready examples 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
8 tasks
Add type ignore comments to cli.command() decorators to fix mypy errors caused by click-default-group not having type stubs. Also add mypy override for the click_default_group module in pyproject.toml. This maintains type safety for the rest of the codebase while allowing the use of the untyped click-default-group library. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implement command-less CLI invocation to make redlines more agent-friendly. Users can now invoke
redlines "source" "test"directly without specifying a command, and it automatically outputs JSON (the most agent-friendly format).Key Changes
CLI Enhancements
comparecommand as the default command using click-default-groupredlines "source" "test"outputs JSON by default--prettyflag for human-readable JSON formattingDependencies
Documentation
Examples
Tests
Benefits for AI Agents
redlines "a" "b"instead ofredlines json "a" "b"🤖 Generated with Claude Code