{"id":37183458,"url":"https://github.com/modzy/cli","last_synced_at":"2026-01-14T21:11:35.363Z","repository":{"id":57640023,"uuid":"392793195","full_name":"modzy/cli","owner":"modzy","description":null,"archived":false,"fork":false,"pushed_at":"2021-10-29T13:59:23.000Z","size":5659,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-06-20T17:29:32.010Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/modzy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.adoc","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-04T18:37:52.000Z","updated_at":"2021-10-29T13:59:26.000Z","dependencies_parsed_at":"2022-09-04T14:02:17.034Z","dependency_job_id":null,"html_url":"https://github.com/modzy/cli","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/modzy/cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modzy%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modzy%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modzy%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modzy%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/modzy","download_url":"https://codeload.github.com/modzy/cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modzy%2Fcli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28434597,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T18:57:19.464Z","status":"ssl_error","status_checked_at":"2026-01-14T18:52:48.501Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-01-14T21:11:34.544Z","updated_at":"2026-01-14T21:11:35.331Z","avatar_url":"https://github.com/modzy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n![Modzy Logo](https://www.modzy.com/wp-content/uploads/2020/06/MODZY-RGB-POS.png)\n[![Go Report Card](https://goreportcard.com/badge/github.com/modzy/cli)](https://goreportcard.com/report/github.com/modzy/cli)\n\n# Modzy Command Line Interface\nModzy's CLI provides terminal commands for some of our most useful API endpoints. Modzy's CLI is designed primarily for \noperations teams to monitor instance health, check on inference statuses, or to quickly query important operational \ninformation. As a result, not all of Modzy's API endpoints are available via the CLI.\n\nFor more detailed information, visit our [CLI Documentation page](https://docs.modzy.com/v1.0.6/docs/cli)\n## Installation\n\n### Homebrew\nTo install the CLI via Homebrew, first tap the Modzy tap:\n\n`brew tap modzy/tap`\n\nAfterwards, you can install the CLI using brew:\n\n`brew install modzy-cli`\n\n### Using Go\nAs a prerequisite for installing the Modzy CLI, you must install have golang installed. Download and install golang \nhere: https://golang.org/doc/install\n\nOnce you've successfully installed golang, open your terminal and run the following command\n\n    go get -u github.com/modzy/cli/modzy\n\n## Documentation\n\nThere exists documentation for all commands within the cli:\n\n    modzy --help\n    modzy models --help\n    modzy models get --help\n    etc.\n\nThe top level `modzy --help` has additional high level documentation on how to use the cli.\n\n## Available Commands\n| **Available Commands** | **Description** |\n| --- | ---|\n| [modzy alerts](https://docs.modzy.com/v1.0.6/docs/modzy-alerts) | List all alerts |\n| [modzy completion](https://docs.modzy.com/v1.0.6/docs/modzy-completion) | Generate the autocompletion script for the specified shell ||\n| [modzy help](https://docs.modzy.com/v1.0.6/docs/modzy-help) | Help about any command |\n| [modzy jobs](https://docs.modzy.com/v1.0.6/docs/modzy-jobs) | Work with inference/preduction jobs |\n| [modzy models](https://docs.modzy.com/v1.0.6/docs/modzy-models) | work with models |\n| [modzy projects](https://docs.modzy.com/v1.0.6/docs/modzy-projects) | work with projects | \n| [modzy status](https://docs.modzy.com/v1.0.6/docs/status) | Returns top level dashboard information for your account | \n| [modzy whoami](https://docs.modzy.com/v1.0.6/docs/modzy-whoami) | Summarize effective authentication information | \n\n## Global Flags\n\n|**Flag** | **Description** | \n|--- |  ---|\n|`--api-key` | Modzy API key to use for authentication |\n|`--base-url` | Modzy API base URL | \n|`-h`, `--help` | Help for Modzy CLI commands | \n|`-p`, `--profile` | profile under which command will be executed | \n|`--team-id` | Modzy API team ID to use for team authentication | \n|`--team-token` | Modzy API team token to use for team authentication | \n| `-v`, `--verbose` | Enable more verbose log output | \n| `--verbose-http` | Enable log output of http request and response data |\n\n## Authentication\nYou can provide your authentication token through any mixture of command flags,\nENV variables, or configuration files.  Precedence is command flag \u003e ENV \u003e configuration file.\n\nIn all three examples below, you will need to replace placeholder values with valid inputs.\nReplace ***`BASE_URL`***  with the URL of your instance of Modzy, such as https://app.modzy.com\nReplace ***`API_KEY`*** with a valid API key string [Here's how to download an API Key from Modzy](doc:view-and-manage-api-keys)\nOptionally, replace ***`TEAM_ID`*** with the ID for the Modzy team you'd like to access\nOptionally, replace ***`TEAM_TOKEN`*** with a valid API key string\n\n### Via Command Flags\nTo authenticate using command flags, you'll need to include `--base-url flag` with each command. You'll also need to include either the `--api-key` flag, or both the `--team-id` and `--team-token` flags.\n```\n$ modzy [command] --base-url BASE_URL {--api-key API_KEY | --team-id TEAM_ID --team-token TEAM_TOKEN}\n```\n\n### Via ENV Variables\nSet the following ENV variables\nMODZY_BASE_URL=***`BASE_URL`***\nMODZY_API_KEY=***`API_KEY`***\nMODZY_TEAM_ID=***`TEAM_ID`***\nMODZY_TEAM_TOKEN=***`TEAM_TOKEN`***\n\n### Via Configuration File\nTo use a configuration file, create a yaml file at any of these locations:\n* `/etc/modzy/{profile}.yaml`\n* `$HOME/.modzy/{profile}.yaml`\n\nThe default profile is called \"default\".\n\nThe yaml file you create should look something like this.\n```\n\t\u003e cat ~/.modzy/default.yaml\n\tbase-url: BASE_URLf\n\t# use an api key:\n\tapi-key: API_KEY\n\t# or use a team key:\n\tteam-id: TEAM_ID\n\tteam-token: TEAM_TOKEN\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodzy%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmodzy%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodzy%2Fcli/lists"}