{"id":21571097,"url":"https://github.com/treblle/treblle-cli","last_synced_at":"2025-04-10T14:20:32.178Z","repository":{"id":227250912,"uuid":"733926694","full_name":"Treblle/treblle-cli","owner":"Treblle","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-15T12:09:47.000Z","size":8239,"stargazers_count":13,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-16T09:02:04.490Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/Treblle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-20T12:58:39.000Z","updated_at":"2024-06-21T07:31:07.600Z","dependencies_parsed_at":"2024-06-21T07:41:16.967Z","dependency_job_id":null,"html_url":"https://github.com/Treblle/treblle-cli","commit_stats":null,"previous_names":["treblle/treblle-cli"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Treblle%2Ftreblle-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Treblle%2Ftreblle-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Treblle%2Ftreblle-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Treblle%2Ftreblle-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Treblle","download_url":"https://codeload.github.com/Treblle/treblle-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248233935,"owners_count":21069493,"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":[],"created_at":"2024-11-24T11:14:52.221Z","updated_at":"2025-04-10T14:20:32.154Z","avatar_url":"https://github.com/Treblle.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Treblle CLI\n\nAPI Insights scores your API using over 30 tests taken from standards and industry best practices across three categories:\n\n- **Design**: how well your API is structured. Is it a well-crafted ship, ready to withstand the rough seas of user demands and scalability?\n\n- **Performance**: does your API respond quickly? It's like checking the wind in your sails – are you moving swiftly and smoothly?\n\n- **Security**: how safe and secure is your API? It's akin to having a strong hull to protect against the stormy seas of cyber threats.\n\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://assets.apiinsights.io/insights-CLI.png\"/\u003e\n\u003c/div\u003e\n\n## Overview\n\nGet insights into your OpenAPI specifications and API using the Treblle CLI.\n\n```md\nThe Treblle CLI tool.\n\nUsage:\n  treblle-cli [command]\n\nAvailable Commands:\n  help        Help about any command\n  insights    Generate an API Insights report.\n\nFlags:\n  -h, --help      help for treblle\n  -v, --version   version for treblle\n\nUse \"treblle-cli [command] --help\" for more information about a command.\n```\n\n## Installing\n\nUsing homebrew on Mac or Linux, you can install the Treblle CLI using:\n\n```bash\nbrew tap treblle/treblle\nbrew install treblle\n```\n\n## API Insights\n\nYou can use the `insights` command on the Treblle CLI to upload your OpenAPI Specification to API Insights, and get your report back in just a few seconds.\n\n```bash\ntreblle-cli insights path/to/openapi-spec.json\n```\n\nYou then have various options available to you. By default you will get an overview of the report, which will allow you to have a high-level overview of your API Insights score. You can also use any of the following options:\n\n### Technology Profile\n\nAdd the `--technology` flag to see the technology profile discovered on your API.\n\n### Details\n\nThe `--details` flag requires one of the following options:\n\n- `--details=performance` to show the performance tests pass/fail for your API.\n- `--details=security` to show the security test pass/fail for your API.\n- `--details=quality` to show the quality test pass/fail for your API.\n- `--details=all` to show the performance, security, and quality test pass/fail for your API.\n\n### Miniumum score limit\n\nThe `--minimum` flag gives you the possibility to set a minimum score in CI/CD environments:\n\n- `--minimum 90` to limit any of tests to be at least 90 to pass\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreblle%2Ftreblle-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftreblle%2Ftreblle-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreblle%2Ftreblle-cli/lists"}