{"id":27945174,"url":"https://github.com/metal-stack/cli","last_synced_at":"2025-05-07T12:56:16.900Z","repository":{"id":281322598,"uuid":"944928045","full_name":"metal-stack/cli","owner":"metal-stack","description":"metal-apiserver cli v2","archived":false,"fork":false,"pushed_at":"2025-05-07T06:08:40.000Z","size":98,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-07T12:56:13.464Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/metal-stack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2025-03-08T08:54:42.000Z","updated_at":"2025-05-07T06:08:44.000Z","dependencies_parsed_at":"2025-03-25T15:30:20.129Z","dependency_job_id":"27e98650-aa4c-4d24-9325-ae9037af000c","html_url":"https://github.com/metal-stack/cli","commit_stats":null,"previous_names":["metal-stack/cli"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal-stack%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal-stack%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal-stack%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal-stack%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metal-stack","download_url":"https://codeload.github.com/metal-stack/cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252883221,"owners_count":21819157,"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":"2025-05-07T12:56:16.313Z","updated_at":"2025-05-07T12:56:16.898Z","avatar_url":"https://github.com/metal-stack.png","language":"Go","readme":"# metal-stack CLI V2\n\n[![Markdown Docs](https://img.shields.io/badge/markdown-docs-blue?link=https%3A%2F%2Fgithub.com%2Fmetal-stack%2Fcli%2Fdocs)](./docs/metalctlv2.md)\n![Go Version](https://img.shields.io/github/go-mod/go-version/metal-stack/cli)\n[![Go Report Card](https://goreportcard.com/badge/github.com/metal-stack/cli)](https://goreportcard.com/report/github.com/metal-stack/cli)\n\nThis is the official V2 CLI for accessing the API of [metal-stack.io](https://metal-stack.io).\n\n***WORK IN PROGRESS, not compatible with current metal-api***\n\n## Installation\n\nDownload locations:\n\n- [metalctlv2-linux-amd64](https://github.com/metal-stack/cli/releases/latest/download/metalctlv2-linux-amd64)\n- [metalctlv2-darwin-amd64](https://github.com/metal-stack/cli/releases/latest/download/metalctlv2-darwin-amd64)\n- [metalctlv2-darwin-arm64](https://github.com/metal-stack/cli/releases/latest/download/metalctlv2-darwin-arm64)\n- [metalctlv2-windows-amd64](https://github.com/metal-stack/cli/releases/latest/download/metalctlv2-windows-amd64)\n\n### Installation on Linux\n\n```bash\ncurl -LO https://github.com/metal-stack/cli/releases/latest/download/metalctlv2-linux-amd64\nchmod +x metalctlv2-linux-amd64\nsudo mv metalctlv2-linux-amd64 /usr/local/bin/metalctlv2\n```\n\n### Installation on MacOS\n\nFor x86 based Macs:\n\n```bash\ncurl -LO https://github.com/metal-stack/cli/releases/latest/download/metalctlv2-darwin-amd64\nchmod +x metalctlv2-darwin-amd64\nsudo mv metalctlv2-darwin-amd64 /usr/local/bin/metalctlv2\n```\n\nFor Apple Silicon (M1) based Macs:\n\n```bash\ncurl -LO https://github.com/metal-stack/cli/releases/latest/download/metalctlv2-darwin-arm64\nchmod +x metalctlv2-darwin-arm64\nsudo mv metalctlv2-darwin-arm64 /usr/local/bin/metalctlv2\n```\n\n### Installation on Windows\n\n```bash\ncurl -LO https://github.com/metal-stack/cli/releases/latest/download/metalctlv2-windows-amd64\ncopy metalctlv2-windows-amd64 metalctlv2.exe\n```\n\n## Usage\n\nAll commands follow a general form:\n\n```bash\nmetalctlv2 \u003centity\u003e [\u003ccategory\u003e] \u003ccommand\u003e \u003cargument\u003e [\u003cflags\u003e]\n```\n\nFor example:\n\n```bash\nmetalctlv2 tenant member list --api-token \u003cyour-token\u003e --api-url \u003capi-url\u003e\nmetalctlv2 ctx add \u003ccontext-name\u003e\n```\n\nThe `api-token`, `api-url` and `project-id` are defaulted by the context, if one exists, and can be omitted.\n\nIn addition to the standard API services, there are also admin services that require an admin token for execution.\n\nYou can access help for every service and command by using `--help` or `-h`. If you encounter any issues not covered in the help prompt, or if you have suggestions for improvement, please feel free to [contact us](mailto:support@metal-stack.io) or open an issue in this repository. Your feedback is greatly appreciated!\n\nA list of all available services (excluding admin topics). For their associated commands, arguments and flags visit the correct [documentation](./docs/metal.md).\n\n| Entity        | Description                                                | Documentation                                         |\n|---------------|------------------------------------------------------------|-------------------------------------------------------|\n| `api-methods` | show available api-methods of the metal-stack.io api       | [metal api-methods](./docs/metalctlv2_api-methods.md) |\n| `completion`  | generate the autocompletion script for the specified shell | [metal completion](./docs/metalctlv2_completion.md)   |\n| `context`     | manage cli contexts                                        | [metal context](./docs/metalctlv2_context.md)         |\n| `health`      | print the client and server health information             | [metal health](./docs/metalctlv2_health.md)           |\n| `ip`          | manage ip entities                                         | [metal ip](./docs/metalctlv2_ip.md)                   |\n| `markdown`    | create markdown documentation                              | [metal completion](./docs/metalctlv2_completion.md)   |\n| `project`     | manage project entities                                    | [metal project](./docs/metalctlv2_project.md)         |\n| `tenant`      | manage tenant entities                                     | [metal tenant](./docs/metalctlv2_tenant.md)           |\n| `token`       | manage token entities                                      | [metal token](./docs/metalctlv2_token.md)             |\n| `user`        | manage user entities                                       | [metal user](./docs/metalctlv2_user.md)               |\n| `version`     | print the client and server version information            | [metal version](./docs/metalctlv2_version.md)         |\n| `login`       | login with oidc and write api-token to the configuration   | [metal login](./docs/metalctlv2_login.md)             |\n\n### Autocompletion\n\nTo successfully set up autocompletion follow this [guide](./docs/metalctlv2_completion.md).\n\n## Authentication and Configuration\n\nTo work with this CLI, it's necessary to create an api-token, this can be done with the login command.\n\n```bash\n$ metalctlv2 login\nStarting server at http://127.0.0.1:35287...\n✔ login successful! Updated and activated context \"local\"\n```\n\nThe project's ID can be copied from the UI, the button is located right next to the project title in the project dashboard. The default API-URL of metal-stack is https://api.metal-stack.io.\n\n```bash\n$ metalctlv2 ctx add \u003ccontext-name\u003e --activate --default-project \u003cproject-uuid\u003e --api-token \u003cyour-token\u003e\n✔ added context \"\u003ccontext-name\u003e\"\n```\n\nThe configuration file is by default written to `~/.metal-stack/config.yaml`.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetal-stack%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetal-stack%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetal-stack%2Fcli/lists"}