{"id":19278350,"url":"https://github.com/icewhaletech/casaos-cli","last_synced_at":"2025-04-22T00:31:49.451Z","repository":{"id":63062616,"uuid":"564850775","full_name":"IceWhaleTech/CasaOS-CLI","owner":"IceWhaleTech","description":"A command-line tool to interact with CasaOS for testing and diagnosing purpose ","archived":false,"fork":false,"pushed_at":"2025-04-16T06:19:27.000Z","size":122,"stargazers_count":17,"open_issues_count":0,"forks_count":17,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-16T07:57:42.725Z","etag":null,"topics":["cli","cobra-cli","go","golang"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IceWhaleTech.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}},"created_at":"2022-11-11T16:43:44.000Z","updated_at":"2025-04-16T06:19:31.000Z","dependencies_parsed_at":"2023-11-20T10:57:45.748Z","dependency_job_id":null,"html_url":"https://github.com/IceWhaleTech/CasaOS-CLI","commit_stats":{"total_commits":67,"total_committers":6,"mean_commits":"11.166666666666666","dds":"0.16417910447761197","last_synced_commit":"51949f2cdc71eaec41db443fb93d8178ca6e5192"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWhaleTech%2FCasaOS-CLI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWhaleTech%2FCasaOS-CLI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWhaleTech%2FCasaOS-CLI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWhaleTech%2FCasaOS-CLI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IceWhaleTech","download_url":"https://codeload.github.com/IceWhaleTech/CasaOS-CLI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250157830,"owners_count":21384331,"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","cobra-cli","go","golang"],"created_at":"2024-11-09T21:09:22.551Z","updated_at":"2025-04-22T00:31:49.204Z","avatar_url":"https://github.com/IceWhaleTech.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CasaOS-CLI\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/IceWhaleTech/CasaOS-CLI.svg)](https://pkg.go.dev/github.com/IceWhaleTech/CasaOS-CLI) [![Go Report Card](https://goreportcard.com/badge/github.com/IceWhaleTech/CasaOS-CLI)](https://goreportcard.com/report/github.com/IceWhaleTech/CasaOS-CLI) [![goreleaser](https://github.com/IceWhaleTech/CasaOS-CLI/actions/workflows/release.yml/badge.svg)](https://github.com/IceWhaleTech/CasaOS-CLI/actions/workflows/release.yml) [![codecov](https://codecov.io/github/IceWhaleTech/CasaOS-CLI/branch/main/graph/badge.svg?token=XHM6PM8C0K)](https://codecov.io/github/IceWhaleTech/CasaOS-CLI)\n\nA command-line tool to interact with CasaOS for testing and diagnosing purpose\n\n## Usage\n\n```text\nA command line interface for CasaOS\n\nUsage:\n  casaos-cli [command]\n\nServices\n  app-management All compose app management and store related commands\n  local-storage  All local storage related commands\n  message-bus    All message bus related commands\n\nAdditional Commands:\n  completion     Generate the autocompletion script for the specified shell\n  help           Help about any command\n  version        Show version\n\nFlags:\n  -h, --help              help for casaos-cli\n  -u, --root-url string   root url of CasaOS API (default \"localhost:80\")\n\nAdditional help topics:\n  casaos-cli gateway        All gateway related commands\n  casaos-cli user           All user related commands\n\nUse \"casaos-cli [command] --help\" for more information about a command.\n```\n\n## Contributing\n\nUse \u003chttps://github.com/spf13/cobra-cli\u003e to add any new command.\n\nFollow example steps below to add commands like `casaos-cli message-bus list event-types`\n\n1. create command scaffold with `cobra-cli add`:\n\n    ```shell\n    go run github.com/spf13/cobra-cli@latest add messageBus --config .cobra.yaml\n    go run github.com/spf13/cobra-cli@latest add messageBusList -p messageBusCmd --config .cobra.yaml\n    go run github.com/spf13/cobra-cli@latest add messageBusListEventTypes -p messageBusListCmd --config .cobra.yaml\n    ```\n\n    \u003e It is important to include `--config .cobra.yaml` to attribute the scaffold code with correct license header.\n\n2. update each `messageBus*.go` file with correct command format:\n\n    ```go\n    // messageBus.go\n    Use:   \"messageBus\",\n    // messageBusList.go\n    Use:   \"messageBusList\",\n    // messageBusListEventTypes.go\n    Use:   \"messageBusListEventTypes\",\n    ```\n\n    becomes\n\n    ```go\n    // messageBus.go\n    Use:   \"message-bus\",\n    // messageBusList.go\n    Use:   \"list\",\n    // messageBusListEventTypes.go\n    Use:   \"event-types\",\n    ```\n\n3. update short and long description for each command, and implement the logics\n\n4. to verify the commands are created correctly, run\n\n    ```shell\n    $ go run main.go message-bus list event-types --help\n    list event types\n\n    Usage:\n    CasaOS-CLI message-bus list event-types [flags]\n\n    Flags:\n    -h, --help   help for event-types\n    ```\n\n\u003e Run `go run github.com/spf13/cobra-cli@latest --help` to see additional help message.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficewhaletech%2Fcasaos-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficewhaletech%2Fcasaos-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficewhaletech%2Fcasaos-cli/lists"}