{"id":25020986,"url":"https://github.com/excoriate/inspector-gadget-cli","last_synced_at":"2025-03-30T10:26:43.579Z","repository":{"id":254566580,"uuid":"846898108","full_name":"Excoriate/inspector-gadget-cli","owner":"Excoriate","description":"A CLI tool for inspecting and analyzing web links.","archived":false,"fork":false,"pushed_at":"2024-08-25T07:57:16.000Z","size":123,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-05T12:18:34.290Z","etag":null,"topics":["cli","link-checker","rust","seo-tools","web-crawler"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Excoriate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-24T09:04:56.000Z","updated_at":"2024-08-25T07:56:56.000Z","dependencies_parsed_at":"2024-08-24T11:53:13.284Z","dependency_job_id":"c550837d-7021-40e4-aa43-5b3c2b42a476","html_url":"https://github.com/Excoriate/inspector-gadget-cli","commit_stats":null,"previous_names":["excoriate/inspector-gadget-cli"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Excoriate%2Finspector-gadget-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Excoriate%2Finspector-gadget-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Excoriate%2Finspector-gadget-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Excoriate%2Finspector-gadget-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Excoriate","download_url":"https://codeload.github.com/Excoriate/inspector-gadget-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246304648,"owners_count":20755941,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","link-checker","rust","seo-tools","web-crawler"],"created_at":"2025-02-05T12:18:35.265Z","updated_at":"2025-03-30T10:26:43.561Z","avatar_url":"https://github.com/Excoriate.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Inspector Gadget CLI\n\nA powerful CLI tool for inspecting and analyzing web links. Handy when it comes to feeding your LLM with the right context.\n\n[![🦀 Rust CI](https://github.com/Excoriate/inspector-gadget-cli/actions/workflows/rust.yml/badge.svg)](https://github.com/Excoriate/inspector-gadget-cli/actions/workflows/rust.yml)\n\n## Installation\n\n### Option 1: Install pre-built binary (Recommended)\n\nYou can install the Inspector Gadget CLI using our installation script:\n\n```bash\ncurl -sSf https://raw.githubusercontent.com/Excoriate/inspector-gadget-cli/main/scripts/install.sh | sh\n```\n\nThis script will download the appropriate binary for your platform, extract it, and install it to `/usr/local/bin` with the correct permissions. You can then run the `inspector` command directly without needing to use `./inspector-gadget`.\n\n### Option 2: Install from Source\n\nTo install Inspector Gadget CLI from source, you can use the provided installation script:\n\n```bash\nbash scripts/install_from_source.sh\n```\n\nThis will clone the repository, build the project, and install the binary to `/usr/local/bin`.\n\n## Usage\n\n```bash\ninspector \u003cURL\u003e [OPTIONS]\n```\n\nOptions:\n\n| Option | Description |\n|--------|-------------|\n| `--output-format \u003cFORMAT\u003e` | Choose between json, yaml, txt, or clipboard (default: json) |\n| `--output-file \u003cFILE\u003e` | Specify the output file name (default: inspect-result-\u003cdomain\u003e.\u003cformat\u003e) |\n| `--log-level \u003cLEVEL\u003e` | Adjust the verbosity of logs (e.g., info, debug, error) (default: info) |\n| `--help` | Displays help information |\n| `--version` | Shows version information |\n| `--show-links` | Show links in the terminal |\n| `--detailed` | Show detailed information including ignored links |\n| `--config \u003cFILE\u003e` | Sets a custom config file |\n| `--ignore-domains \u003cDOMAINS\u003e` | Comma-separated list of domains to ignore |\n| `--ignore-regex \u003cREGEX\u003e` | Comma-separated list of regex patterns to ignore URLs |\n| `--forbidden-domains \u003cDOMAINS\u003e` | Comma-separated list of forbidden domains |\n| `--ignored-childs \u003cPATHS\u003e` | Comma-separated list of child paths to ignore |\n| `--timeout \u003cSECONDS\u003e` | Timeout in seconds for each HTTP request |\n\nExample:\n```bash\ninspector https://docs.dagger.io --show-links --output-format=txt --output-file=dagger-doc-links\n```\n\n## Configuration\n\nThe inspector tool uses a YAML configuration file named `.inspector-config.yml` in the user's home directory. This file allows you to customize various aspects of the link inspection process.\n\nHere's a description of the configuration options:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `url` | String | The base URL to start the inspection from (required) |\n| `ignore` | Object | Contains settings for ignoring certain URLs |\n| `ignore.domains` | Array of Strings | List of domain suffixes to ignore |\n| `ignore.regex` | Array of Strings | List of regex patterns to ignore URLs |\n| `forbidden_domains` | Array of Strings | List of domain suffixes that are forbidden to scan |\n| `ignored_childs` | Array of Strings | List of URL path prefixes to ignore |\n| `timeout` | Integer | Timeout in seconds for each HTTP request |\n| `default_output` | String | Default output format if not specified in CLI arguments |\n\n### Example Configuration\n\n```yaml\nurl: https://docs.dagger.io\nignore:\n  domains:\n    - \"example.com\"\n    - \"test.org\"\n  regex:\n    - \"^https?://localhost\"\n    - \"^https?://127\\\\.0\\\\.0\\\\.1\"\nforbidden_domains:\n  - \"forbidden.com\"\n  - \"restricted.org\"\nignored_childs:\n  - \"/api/\"\n  - \"/internal/\"\ntimeout: 30\ndefault_output: \"json\"\n```\n\nYou can use a custom configuration file by specifying its path:\n\n```bash\ninspector https://example.com --config /path/to/custom-config.yml\n```\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.\n\n## License\n\nInspector CLI is licensed under the [MIT License](LICENSE).\n\n## Examples\n\n### Terragrunt Documentation\n\nTo fetch all the Terragrunt documentation, you can use the following commands:\n\n```bash\n# Locally\njust run https://terragrunt.gruntwork.io/docs/features/keep-your-remote-state-configuration-dry/ --show-links --output-format=txt --output-file=terragrunt-docs-links\n# or using the inspector cli\ninspector https://terragrunt.gruntwork.io/docs/features/keep-your-remote-state-configuration-dry/ --show-links --output-format=txt -o terragrunt-docs-links\n```\n\nAlternatively, you can use a configuration file:\n\n```bash\n# Locally\njust run https://terragrunt.gruntwork.io/docs/features/keep-your-remote-state-configuration-dry/ --config docs/examples/terragrunt-docs/terragrunt-inspector-config.yml\n# or using the inspector cli\ninspector https://terragrunt.gruntwork.io/docs/features/keep-your-remote-state-configuration-dry/ --config docs/examples/terragrunt-docs/terragrunt-inspector-config.yml\n```\n\nThe `terragrunt-inspector-config.yml` file contains the following configuration:\n\n```yaml\nurl: https://terragrunt.gruntwork.io/docs/features/keep-your-remote-state-configuration-dry/\nignore:\n  domains:\n    - \"github.com\"\n    - \"twitter.com\"\n    - \"linkedin.com\"\n  regex:\n    - \"^https://terragrunt.gruntwork.io/docs/features/keep-your-remote-state-configuration-dry/#.*$\"\nforbidden_domains:\n  - \"example.com\"\nignored_childs:\n  - \"/community/\"\n  - \"/plugins/\"\ntimeout: 30\ndefault_output: \"json\"\n```\n\n### Terraform Documentation\n\nTo fetch all the Terraform documentation, you can use the following commands:\n\n```bash\n# Locally\njust run https://terraform-docs.io/user-guide/introduction/ --show-links --output-format=txt --output-file=terraform-docs-links\n# or using the inspector cli\ninspector https://terraform-docs.io/user-guide/introduction/ --show-links --output-format=txt -o terraform-docs-links\n```\n\nAlternatively, you can use a configuration file:\n\n```bash\n# Locally\njust run https://terraform-docs.io/user-guide/introduction/ --config docs/examples/terraform-docs/terraform-docs-inspector-config.yml\n# or using the inspector cli\ninspector https://terraform-docs.io/user-guide/introduction/ --config docs/examples/terraform-docs/terraform-docs-inspector-config.yml\n```\n\nThe `terraform-docs-inspector-config.yml` file contains the following configuration:\n\n```yaml\nurl: https://terraform-docs.io/user-guide/introduction/\nignore:\n  domains:\n    - \"github.com\"\n    - \"twitter.com\"\n    - \"linkedin.com\"\n  regex:\n    - \"^https://terraform-docs.io/user-guide/.*#.*$\"\nforbidden_domains:\n  - \"example.com\"\nignored_childs:\n  - \"/community/\"\n  - \"/plugins/\"\ntimeout: 30\ndefault_output: \"json\"","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexcoriate%2Finspector-gadget-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexcoriate%2Finspector-gadget-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexcoriate%2Finspector-gadget-cli/lists"}