tidyout-cli 0.1.0__tar.gz → 0.2.0__tar.gz

tidyout_cli-0.2.0/.claude/settings.local.json

@@ -0,0 +1,15 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(python3 -m pip show tidyout-cli)",
+      "Bash(python3 -m pip show -f tidyout-cli)",
+      "Read(//Users/sathishkumar/Library/Python/3.9/bin/**)",
+      "Bash(python3 -c \"import site; print\\(site.USER_BASE\\)\")",
+      "Bash(python3 -)",
+      "Bash(python3 -m pip uninstall -y tidyout-cli)",
+      "Bash(python3 -m pip install --user .)",
+      "Bash(python3 -m pytest -q)",
+      "Bash(python3 -m pip install --user -q pytest)"
+    ]
+  }
+}

{tidyout_cli-0.1.0 → tidyout_cli-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tidyout-cli
-Version: 0.1.0
+Version: 0.2.0
 Summary: CLI wrapper that compresses command output for AI agents, reducing token usage by 60-97%
 License: MIT
 Keywords: ai,cli,compression,developer-tools,tokens
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
 
 # tidyout
 
-A CLI wrapper that sits between you (or your AI agent) and the terminal. Prefix any command with `tidy` and tidyout executes it, strips the noise, and returns a compressed version with a token savings summary.
+A CLI wrapper that sits between you (or your AI agent) and the terminal. Prefix any command with `tidyout` and tidyout executes it, strips the noise, and returns a compressed version with a token savings summary.
 
 ```
 ✂️  tidyout: 312 lines → 18 lines | saved ~2376 tokens (94% reduction)
@@ -40,14 +40,14 @@ pip install tidyout-cli
 ## Usage
 
 ```bash
-tidy pytest tests/
-tidy git status
-tidy git log
-tidy ls -la
-tidy find . -name "*.py"
-tidy docker logs mycontainer
-tidy npm install
-tidy cargo build
+tidyout pytest tests/
+tidyout git status
+tidyout git log
+tidyout ls -la
+tidyout find . -name "*.py"
+tidyout docker logs mycontainer
+tidyout npm install
+tidyout cargo build
 ```
 
 Every run ends with a summary line:
@@ -76,25 +76,28 @@ Commands without a matching rule pass through unchanged and still show the summa
 | `make` | Entering/Leaving directory noise | ~40% |
 | `cargo build` | dependency Compiling lines, Downloading | ~75% |
 
-## `tidy init` — inject rules into your AI agent config
+## `tidyout init` — inject rules into your AI agent config
 
-Running `tidy init` in your project directory automatically tells your AI agent to always use `tidy`:
+Running `tidyout init` in your project directory automatically tells your AI agent to always use `tidyout`:
 
 ```bash
-tidy init
+tidyout init
 ```
 
-It detects which config file to update:
+It writes to **all** major AI agent config files at once — creating missing ones and appending to existing ones:
 
-- `CLAUDE.md` exists → appends tidyout usage rules
-- `.cursorrules` exists → appends tidyout usage rules
-- Neither exists → creates `CLAUDE.md` with the rules
+| File | AI tool |
+|---|---|
+| `CLAUDE.md` | Claude Code |
+| `.cursorrules` | Cursor |
+| `.windsurfrules` | Windsurf |
+| `.github/copilot-instructions.md` | GitHub Copilot |
 
 Injected block:
 
 ```markdown
 ## Token Optimization with tidyout
-Always prefix the following commands with `tidy` when running in terminal:
+Always prefix the following commands with `tidyout` when running in terminal:
 pytest, npm test, jest, rspec, git status, git log, ls, find, tree,
 pip install, npm install, docker logs, docker ps, make, cargo build
 This reduces token usage by 60-97% on command outputs.

{tidyout_cli-0.1.0 → tidyout_cli-0.2.0}/README.md

@@ -1,6 +1,6 @@
 # tidyout
 
-A CLI wrapper that sits between you (or your AI agent) and the terminal. Prefix any command with `tidy` and tidyout executes it, strips the noise, and returns a compressed version with a token savings summary.
+A CLI wrapper that sits between you (or your AI agent) and the terminal. Prefix any command with `tidyout` and tidyout executes it, strips the noise, and returns a compressed version with a token savings summary.
 
 ```
 ✂️  tidyout: 312 lines → 18 lines | saved ~2376 tokens (94% reduction)
@@ -17,14 +17,14 @@ pip install tidyout-cli
 ## Usage
 
 ```bash
-tidy pytest tests/
-tidy git status
-tidy git log
-tidy ls -la
-tidy find . -name "*.py"
-tidy docker logs mycontainer
-tidy npm install
-tidy cargo build
+tidyout pytest tests/
+tidyout git status
+tidyout git log
+tidyout ls -la
+tidyout find . -name "*.py"
+tidyout docker logs mycontainer
+tidyout npm install
+tidyout cargo build
 ```
 
 Every run ends with a summary line:
@@ -53,25 +53,28 @@ Commands without a matching rule pass through unchanged and still show the summa
 | `make` | Entering/Leaving directory noise | ~40% |
 | `cargo build` | dependency Compiling lines, Downloading | ~75% |
 
-## `tidy init` — inject rules into your AI agent config
+## `tidyout init` — inject rules into your AI agent config
 
-Running `tidy init` in your project directory automatically tells your AI agent to always use `tidy`:
+Running `tidyout init` in your project directory automatically tells your AI agent to always use `tidyout`:
 
 ```bash
-tidy init
+tidyout init
 ```
 
-It detects which config file to update:
+It writes to **all** major AI agent config files at once — creating missing ones and appending to existing ones:
 
-- `CLAUDE.md` exists → appends tidyout usage rules
-- `.cursorrules` exists → appends tidyout usage rules
-- Neither exists → creates `CLAUDE.md` with the rules
+| File | AI tool |
+|---|---|
+| `CLAUDE.md` | Claude Code |
+| `.cursorrules` | Cursor |
+| `.windsurfrules` | Windsurf |
+| `.github/copilot-instructions.md` | GitHub Copilot |
 
 Injected block:
 
 ```markdown
 ## Token Optimization with tidyout
-Always prefix the following commands with `tidy` when running in terminal:
+Always prefix the following commands with `tidyout` when running in terminal:
 pytest, npm test, jest, rspec, git status, git log, ls, find, tree,
 pip install, npm install, docker logs, docker ps, make, cargo build
 This reduces token usage by 60-97% on command outputs.

{tidyout_cli-0.1.0 → tidyout_cli-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "tidyout-cli"
-version = "0.1.0"
+version = "0.2.0"
 description = "CLI wrapper that compresses command output for AI agents, reducing token usage by 60-97%"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -28,7 +28,7 @@ dependencies = [
 ]
 
 [project.scripts]
-tidy = "tidyout.cli:main"
+tidyout = "tidyout.cli:main"
 
 [project.optional-dependencies]
 dev = [

tidyout_cli-0.2.0/tests/test_cli.py

@@ -0,0 +1,149 @@
+import os
+import pytest
+from pathlib import Path
+
+from tidyout.init_agent import run_init, TIDYOUT_BLOCK, AI_CONFIG_FILES
+
+
+def _chdir(tmp_path):
+    orig = os.getcwd()
+    os.chdir(tmp_path)
+    return orig
+
+
+# ---------------------------------------------------------------------------
+# All files created when none exist
+# ---------------------------------------------------------------------------
+
+def test_init_creates_all_config_files_when_none_exist(tmp_path):
+    orig = _chdir(tmp_path)
+    try:
+        run_init()
+        for rel in AI_CONFIG_FILES:
+            path = tmp_path / rel
+            assert path.exists(), f"{rel} was not created"
+            assert "tidyout" in path.read_text()
+    finally:
+        os.chdir(orig)
+
+
+def test_init_all_files_contain_key_commands(tmp_path):
+    orig = _chdir(tmp_path)
+    try:
+        run_init()
+        for rel in AI_CONFIG_FILES:
+            content = (tmp_path / rel).read_text()
+            for cmd in ["pytest", "git status", "git log", "docker logs", "npm install"]:
+                assert cmd in content, f"{cmd} missing from {rel}"
+    finally:
+        os.chdir(orig)
+
+
+# ---------------------------------------------------------------------------
+# Append to existing files, create missing ones
+# ---------------------------------------------------------------------------
+
+def test_init_appends_to_existing_claude_md(tmp_path):
+    orig = _chdir(tmp_path)
+    try:
+        claude_md = tmp_path / "CLAUDE.md"
+        claude_md.write_text("# Existing content\n")
+        run_init()
+        content = claude_md.read_text()
+        assert "# Existing content" in content
+        assert "tidyout" in content
+    finally:
+        os.chdir(orig)
+
+
+def test_init_appends_to_existing_cursorrules(tmp_path):
+    orig = _chdir(tmp_path)
+    try:
+        cursorrules = tmp_path / ".cursorrules"
+        cursorrules.write_text("# Existing cursor rules\n")
+        run_init()
+        content = cursorrules.read_text()
+        assert "# Existing cursor rules" in content
+        assert "tidyout" in content
+    finally:
+        os.chdir(orig)
+
+
+def test_init_appends_to_existing_windsurfrules(tmp_path):
+    orig = _chdir(tmp_path)
+    try:
+        windsurfrules = tmp_path / ".windsurfrules"
+        windsurfrules.write_text("# Windsurf config\n")
+        run_init()
+        content = windsurfrules.read_text()
+        assert "# Windsurf config" in content
+        assert "tidyout" in content
+    finally:
+        os.chdir(orig)
+
+
+def test_init_appends_to_existing_copilot_instructions(tmp_path):
+    orig = _chdir(tmp_path)
+    try:
+        copilot = tmp_path / ".github" / "copilot-instructions.md"
+        copilot.parent.mkdir()
+        copilot.write_text("# Copilot instructions\n")
+        run_init()
+        content = copilot.read_text()
+        assert "# Copilot instructions" in content
+        assert "tidyout" in content
+    finally:
+        os.chdir(orig)
+
+
+def test_init_creates_github_dir_for_copilot(tmp_path):
+    orig = _chdir(tmp_path)
+    try:
+        run_init()
+        copilot = tmp_path / ".github" / "copilot-instructions.md"
+        assert copilot.exists()
+    finally:
+        os.chdir(orig)
+
+
+# ---------------------------------------------------------------------------
+# Mixed: some files exist, some don't
+# ---------------------------------------------------------------------------
+
+def test_init_writes_to_all_files_regardless_of_which_exist(tmp_path):
+    orig = _chdir(tmp_path)
+    try:
+        # Pre-create only CLAUDE.md
+        (tmp_path / "CLAUDE.md").write_text("# Claude\n")
+        run_init()
+        for rel in AI_CONFIG_FILES:
+            path = tmp_path / rel
+            assert path.exists(), f"{rel} should exist after init"
+            assert "tidyout" in path.read_text()
+    finally:
+        os.chdir(orig)
+
+
+# ---------------------------------------------------------------------------
+# Output messages
+# ---------------------------------------------------------------------------
+
+def test_init_prints_created_for_new_files(tmp_path, capsys):
+    orig = _chdir(tmp_path)
+    try:
+        run_init()
+        out = capsys.readouterr().out
+        assert "created" in out
+    finally:
+        os.chdir(orig)
+
+
+def test_init_prints_appended_for_existing_files(tmp_path, capsys):
+    orig = _chdir(tmp_path)
+    try:
+        (tmp_path / "CLAUDE.md").write_text("# Existing\n")
+        run_init()
+        out = capsys.readouterr().out
+        assert "appended" in out
+    finally:
+        os.chdir(orig)

tidyout_cli-0.2.0/tidyout/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.1"

{tidyout_cli-0.1.0 → tidyout_cli-0.2.0}/tidyout/cli.py

@@ -9,8 +9,8 @@ def main():
     args = sys.argv[1:]
 
     if not args:
-        print("Usage: tidy <command> [args...]")
-        print("       tidy init")
+        print("Usage: tidyout <command> [args...]")
+        print("       tidyout init")
         sys.exit(1)
 
     if args[0] == "init":

tidyout_cli-0.2.0/tidyout/init_agent.py

@@ -0,0 +1,34 @@
+from pathlib import Path
+
+TIDYOUT_BLOCK = """
+## Token Optimization with tidyout
+Always prefix the following commands with `tidyout` when running in terminal:
+pytest, npm test, jest, rspec, git status, git log, ls, find, tree,
+pip install, npm install, docker logs, docker ps, make, cargo build
+This reduces token usage by 60-97% on command outputs.
+"""
+
+# All major AI IDE / agent config files
+AI_CONFIG_FILES = [
+    "CLAUDE.md",                          # Claude Code
+    ".cursorrules",                        # Cursor
+    ".windsurfrules",                      # Windsurf
+    ".github/copilot-instructions.md",    # GitHub Copilot
+]
+
+
+def run_init():
+    cwd = Path.cwd()
+
+    for rel_path in AI_CONFIG_FILES:
+        target = cwd / rel_path
+        target.parent.mkdir(parents=True, exist_ok=True)
+
+        if target.exists():
+            with open(target, "a") as f:
+                f.write(TIDYOUT_BLOCK)
+            print(f"  appended → {rel_path}")
+        else:
+            with open(target, "w") as f:
+                f.write(TIDYOUT_BLOCK.lstrip())
+            print(f"  created  → {rel_path}")

tidyout_cli-0.1.0/tests/test_cli.py

@@ -1,98 +0,0 @@
-import os
-import pytest
-from pathlib import Path
-
-from tidyout.init_agent import run_init, TIDYOUT_BLOCK
-
-
-def test_init_creates_claude_md_when_neither_exists(tmp_path):
-    orig = os.getcwd()
-    os.chdir(tmp_path)
-    try:
-        run_init()
-        claude_md = tmp_path / "CLAUDE.md"
-        assert claude_md.exists()
-        content = claude_md.read_text()
-        assert "tidyout" in content
-        assert "tidy" in content
-    finally:
-        os.chdir(orig)
-
-
-def test_init_appends_to_existing_claude_md(tmp_path):
-    orig = os.getcwd()
-    os.chdir(tmp_path)
-    try:
-        claude_md = tmp_path / "CLAUDE.md"
-        claude_md.write_text("# Existing content\n")
-        run_init()
-        content = claude_md.read_text()
-        assert "# Existing content" in content
-        assert "tidyout" in content
-    finally:
-        os.chdir(orig)
-
-
-def test_init_does_not_create_new_claude_md_when_cursorrules_exists(tmp_path):
-    orig = os.getcwd()
-    os.chdir(tmp_path)
-    try:
-        cursorrules = tmp_path / ".cursorrules"
-        cursorrules.write_text("# Cursor rules\n")
-        run_init()
-        assert not (tmp_path / "CLAUDE.md").exists()
-        assert "tidyout" in cursorrules.read_text()
-    finally:
-        os.chdir(orig)
-
-
-def test_init_appends_to_cursorrules(tmp_path):
-    orig = os.getcwd()
-    os.chdir(tmp_path)
-    try:
-        cursorrules = tmp_path / ".cursorrules"
-        cursorrules.write_text("# Cursor rules\n")
-        run_init()
-        content = cursorrules.read_text()
-        assert "# Cursor rules" in content
-        assert "tidyout" in content
-    finally:
-        os.chdir(orig)
-
-
-def test_init_prefers_claude_md_over_cursorrules(tmp_path):
-    orig = os.getcwd()
-    os.chdir(tmp_path)
-    try:
-        claude_md = tmp_path / "CLAUDE.md"
-        cursorrules = tmp_path / ".cursorrules"
-        claude_md.write_text("# Claude\n")
-        cursorrules.write_text("# Cursor\n")
-        run_init()
-        assert "tidyout" in claude_md.read_text()
-        assert "tidyout" not in cursorrules.read_text()
-    finally:
-        os.chdir(orig)
-
-
-def test_init_block_contains_key_commands(tmp_path):
-    orig = os.getcwd()
-    os.chdir(tmp_path)
-    try:
-        run_init()
-        content = (tmp_path / "CLAUDE.md").read_text()
-        for cmd in ["pytest", "git status", "git log", "docker logs", "npm install"]:
-            assert cmd in content
-    finally:
-        os.chdir(orig)
-
-
-def test_init_prints_action(tmp_path, capsys):
-    orig = os.getcwd()
-    os.chdir(tmp_path)
-    try:
-        run_init()
-        out = capsys.readouterr().out
-        assert "CLAUDE.md" in out
-    finally:
-        os.chdir(orig)

tidyout_cli-0.1.0/tidyout/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.0"

tidyout_cli-0.1.0/tidyout/init_agent.py

@@ -1,28 +0,0 @@
-from pathlib import Path
-
-TIDYOUT_BLOCK = """
-## Token Optimization with tidyout
-Always prefix the following commands with `tidy` when running in terminal:
-pytest, npm test, jest, rspec, git status, git log, ls, find, tree,
-pip install, npm install, docker logs, docker ps, make, cargo build
-This reduces token usage by 60-97% on command outputs.
-"""
-
-
-def run_init():
-    cwd = Path.cwd()
-    claude_md = cwd / "CLAUDE.md"
-    cursorrules = cwd / ".cursorrules"
-
-    if claude_md.exists():
-        with open(claude_md, "a") as f:
-            f.write(TIDYOUT_BLOCK)
-        print(f"Appended tidyout rules to {claude_md}")
-    elif cursorrules.exists():
-        with open(cursorrules, "a") as f:
-            f.write(TIDYOUT_BLOCK)
-        print(f"Appended tidyout rules to {cursorrules}")
-    else:
-        with open(claude_md, "w") as f:
-            f.write(TIDYOUT_BLOCK.lstrip())
-        print(f"Created {claude_md} with tidyout rules")