feat: Create rmagic cli

.coderabbitai.yaml

@@ -73,6 +73,7 @@ reviews:
             "!*.svg",
             "!*.ico",
             "!*.wxs",
+            "!third_party/**",
         ]
     path_instructions:
         - path: "src/lib.rs"

.gitattributes

@@ -58,6 +58,10 @@ LICENSE text
 *.ico binary
 *.svg text
 
+# Test files
+**/*.result binary
+**/*.testfile binary
+
 # Font files
 *.ttf binary
 *.eot binary

.github/workflows/ci.yml

@@ -156,7 +156,7 @@ jobs:
                   files: lcov.info
                   fail_ci_if_error: false
                   token: ${{ secrets.CODECOV_TOKEN }}
-                  slug: EvilBit-Labs/StringyMcStringFace
+                  slug: EvilBit-Labs/libmagic-rs
             - uses: qltysh/qlty-action/coverage@v2
               with:
                   token: ${{ secrets.QLTY_COVERAGE_TOKEN }}

.github/workflows/compatibility.yml

@@ -0,0 +1,39 @@
+name: Compatibility Tests
+
+on:
+    push:
+        branches: [main, develop]
+    pull_request:
+        branches: [main, develop]
+    schedule:
+        # Run daily at 2 AM UTC to catch any regressions
+        - cron: "0 2 * * *"
+
+jobs:
+    compatibility-tests:
+        name: Compatibility Tests
+        runs-on: ${{ matrix.os }}
+
+        strategy:
+            matrix:
+                os: [ubuntu-latest, windows-latest, macos-latest]
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v5
+
+            - uses: dtolnay/rust-toolchain@1.90
+
+            - name: Install just task runner
+              uses: taiki-e/install-action@v2
+              with:
+                tool: just
+
+            - name: Verify compatibility test files are available
+              run: just verify-compatibility-tests
+
+            - name: Build rmagic
+              run: cargo build --release
+
+            - name: Run compatibility tests
+              run: cargo test test_compatibility_with_original_libmagic -- --ignored

.gitignore

@@ -129,4 +129,3 @@ megalinter-reports/
 .intentionally-empty-file.o
 
 # Files for validating the tooling
-test_files/

.kiro/hooks/ci-auto-fix.kiro.hook

@@ -6,16 +6,11 @@
   "when": {
     "type": "userTriggered",
     "patterns": [
-      "**/*.rs",
-      "**/Cargo.toml",
-      "**/Cargo.lock",
-      "justfile",
-      "deny.toml",
-      "rust-toolchain.toml"
+      "**/*.rs"
     ]
   },
   "then": {
     "type": "askAgent",
     "prompt": "1. First, run `just ci-check` to identify any failures\n2. Analyze the output to understand what specific checks are failing. If everything passes, you're done.\n3. Make minimal, targeted fixes to address ONLY the failing checks:\n- For formatting issues: run `just format`\n- For linting issues (clippy): fix the specific violations reported (rerun with `just lint-rust` / `just lint-rust-min`)\n- For compilation/type errors: fix the underlying Rust code until `just check` (or `cargo check`) succeeds\n- For test failures: fix the failing tests or underlying code (verify with `just test` or `just test-ci`)\n- For dependency security/advisory issues: run `just audit` (cargo-audit) and/or update `Cargo.toml` then `cargo update`\n- For license/compliance issues: run `just deny` and address cargo-deny findings\n4. After making fixes, run `just ci-check` again to verify all checks pass\n5. If any checks still fail, repeat steps 2-4 until all checks pass\n6. Provide a summary of what was fixed and confirm that `just ci-check` now passes completely\nKeep changes minimal and focused - only fix what's actually causing the CI failures. Do not make unnecessary refactoring or style changes beyond what's required to pass the checks."
   }
-}
+}

.mdformat.toml

@@ -8,6 +8,8 @@ exclude = [
     "**/CHANGELOG.md",
     "target/**",
     "megalinter-reports/**",
+    "**/*.result",
+    "**/*.testfile",
 ]
 validate = true
 number = true

.pre-commit-config.yaml

@@ -54,25 +54,25 @@ repos:
       hooks:
           - id: cargo-machete
 
-    # Markdown formatting and linting (temporarily disabled in CI due to path issues)
-    - repo: https://github.com/hukkin/mdformat
-      rev: 0.7.22
-      hooks:
-          - id: mdformat
-            additional_dependencies:
-                - mdformat-gfm
-                - mdformat-admon
-                - mdformat-config
-                - mdformat-footnote
-                - mdformat-frontmatter
-                - mdformat-simple-breaks
-                - mdformat-tables
-                - mdformat-web
-                - mdformat-wikilink
-                - mdformat-gfm-alerts
-                - mdformat-rustfmt
-                - mdformat-toc
-            files: \.(md|mdx)$
+    # Markdown formatting and linting (temporarily disabled due to rust code block formatting issues)
+    # - repo: https://github.com/hukkin/mdformat
+    #   rev: 0.7.22
+    #   hooks:
+    #       - id: mdformat
+    #         additional_dependencies:
+    #             - mdformat-gfm
+    #             - mdformat-admon
+    #             - mdformat-config
+    #             - mdformat-footnote
+    #             - mdformat-frontmatter
+    #             - mdformat-simple-breaks
+    #             - mdformat-tables
+    #             - mdformat-web
+    #             - mdformat-wikilink
+    #             - mdformat-gfm-alerts
+    #             - mdformat-toc
+    #         files: \.(md|mdx)$
+    #         exclude: ^target/|
 
     # Security audit for Rust dependencies (moved to CI)
     - repo: local

.prettierignore

@@ -1,2 +1,4 @@
 **/*.md
 **/*.yml
+**/*.result
+**/*.testfile

Cargo.toml

@@ -157,8 +157,12 @@ thiserror = "2.0.17"
 
 [dev-dependencies]
 criterion = "0.7.0"
+insta = { version = "1.39.0", features = ["json"] }
 nix = { version = "0.30", features = ["fs"] }
 proptest = "1.8.0"
+regex = "1.11.0"
+temp-env = "0.2.0"
+tempfile = "3.8.1"
 
 # The profile that 'dist' will build with
 [profile.dist]

docs/src/cli-reference.md

@@ -18,6 +18,7 @@ rmagic [OPTIONS] <FILE>...
 - **Description**: Path to the file(s) to analyze
 - **Multiple**: Yes, can specify multiple files
 - **Examples**:
+
   ```bash
   rmagic file.bin
   rmagic file1.exe file2.pdf file3.zip
@@ -28,6 +29,7 @@ rmagic [OPTIONS] <FILE>...
 
 - **Description**: Display help information and exit
 - **Example**:
+
   ```bash
   rmagic --help
   ```
@@ -36,6 +38,7 @@ rmagic [OPTIONS] <FILE>...
 
 - **Description**: Display version information and exit
 - **Example**:
+
   ```bash
   rmagic --version
   ```
@@ -47,10 +50,13 @@ rmagic [OPTIONS] <FILE>...
 - **Description**: Output results in JSON format instead of text
 - **Default**: Text format
 - **Example**:
+
   ```bash
   rmagic --json file.bin
   ```
+
 - **Output Example**:
+
   ```json
   {
     "filename": "file.bin",
@@ -65,6 +71,7 @@ rmagic [OPTIONS] <FILE>...
 - **Description**: Output results in text format (default behavior)
 - **Default**: Enabled
 - **Example**:
+
   ```bash
   rmagic --text file.bin
   # Output: file.bin: ELF 64-bit LSB executable
@@ -78,6 +85,7 @@ rmagic [OPTIONS] <FILE>...
 - **Type**: Path to magic file
 - **Default**: Built-in magic database
 - **Example**:
+
   ```bash
   rmagic --magic-file custom.magic file.bin
   rmagic --magic-file /usr/share/misc/magic file.bin
@@ -90,6 +98,7 @@ rmagic [OPTIONS] <FILE>...
 - **Description**: Output MIME type instead of description
 - **Status**: 📋 Planned
 - **Example**:
+
   ```bash
   rmagic --mime-type file.bin
   # Output: application/x-executable
@@ -100,6 +109,7 @@ rmagic [OPTIONS] <FILE>...
 - **Description**: Output MIME encoding
 - **Status**: 📋 Planned
 - **Example**:
+
   ```bash
   rmagic --mime-encoding text.txt
   # Output: us-ascii
@@ -110,6 +120,7 @@ rmagic [OPTIONS] <FILE>...
 - **Description**: Brief output (no filename prefix)
 - **Status**: 📋 Planned
 - **Example**:
+
   ```bash
   rmagic --brief file.bin
   # Output: ELF 64-bit LSB executable
@@ -236,6 +247,7 @@ rmagic --recursive /path/to/directory/
 - **Description**: Default magic file path
 - **Default**: Built-in magic database
 - **Example**:
+
   ```bash
   export MAGIC=/usr/local/share/magic
   rmagic file.bin  # Uses /usr/local/share/magic
@@ -246,6 +258,7 @@ rmagic --recursive /path/to/directory/
 - **Description**: Enable debug output
 - **Values**: `0` (off), `1` (basic), `2` (verbose)
 - **Example**:
+
   ```bash
   RMAGIC_DEBUG=1 rmagic file.bin
   ```

docs/src/development.md

@@ -312,8 +312,10 @@ use libmagic_rs::*;
 #[test]
 fn test_end_to_end_workflow() {
     // Test complete workflows
-    let db = MagicDatabase::load_from_file("test_files/magic/simple.magic").unwrap();
-    let result = db.evaluate_file("test_files/samples/elf64").unwrap();
+    let db = MagicDatabase::load_from_file("third_party/magic.mgc").unwrap();
+    let result = db
+        .evaluate_file("third_party/tests/elf64.testfile")
+        .unwrap();
     assert_eq!(result.description, "ELF 64-bit LSB executable");
 }
 ```

docs/src/getting-started.md

@@ -121,7 +121,7 @@ libmagic-rs/
 │   └── io/
 │       └── mod.rs          # I/O utilities (placeholder)
 ├── tests/                  # Integration tests
-├── test_files/             # Test magic files and samples
+├── third_party/            # Canonical libmagic tests and magic files
 └── docs/                   # This documentation
 ```
 

docs/src/testing.md

@@ -226,8 +226,8 @@ Validate against GNU `file` command:
 ```rust
 #[test]
 fn test_elf_detection_compatibility() {
-    let gnu_result = run_gnu_file("test_files/elf64_sample");
-    let our_result = evaluate_file("test_files/elf64_sample");
+    let gnu_result = run_gnu_file("third_party/tests/elf64.testfile");
+    let our_result = evaluate_file("third_party/tests/elf64.testfile");
 
     assert_eq!(extract_file_type(&gnu_result), our_result.description);
 }
@@ -452,6 +452,61 @@ cargo flamegraph --bench parser_bench
 valgrind --tool=massif target/release/rmagic large_file.bin
 ```
 
+## CLI Testing and Cross-Platform Snapshots
+
+### CLI Integration Tests
+
+CLI functionality is tested using integration tests with insta snapshots to ensure consistent output across different platforms.
+
+### Cross-Platform Normalization
+
+**Important**: CLI insta snapshots must use the normalization helper to ensure consistent results between Windows and Unix systems:
+
+```rust
+mod common;
+
+#[test]
+fn test_cli_help_output() {
+    let result = run_cli(&["--help"]);
+    let stdout = String::from_utf8(result.stdout).unwrap();
+
+    // REQUIRED: Use normalization for CLI snapshots
+    let normalized_stdout = common::normalize_cli_output(&stdout);
+    assert_snapshot!("help_output", normalized_stdout);
+}
+```
+
+### Normalization Features
+
+The `common::normalize_cli_output()` function handles:
+
+- **Executable Names**: Converts `rmagic.exe` → `rmagic` for Windows compatibility
+- **Path Prefixes**: Removes Windows `\\?\\` path prefixes
+- **Error Messages**: Filters out cargo-specific error output
+
+### Running CLI Tests
+
+```bash
+# Run all CLI integration tests
+cargo test --test cli_integration_tests
+
+# Run CLI normalization tests
+cargo test --test cli_normalization
+
+# Review snapshot changes
+cargo insta review
+
+# Accept all snapshot changes (use with caution)
+cargo insta accept
+```
+
+### Snapshot Best Practices
+
+1. **Always Normalize**: Use `normalize_cli_output()` for CLI snapshots
+2. **Review Changes**: Always review snapshot diffs with `cargo insta review`
+3. **Test Cross-Platform**: Verify tests pass on both Windows and Unix
+4. **Keep Snapshots Small**: Use focused tests for specific CLI features
+
 ## Future Testing Plans
 
 ### Integration Testing