https://github.com/icewhaletech/casaos-cli

A command-line tool to interact with CasaOS for testing and diagnosing purpose
https://github.com/icewhaletech/casaos-cli

cli cobra-cli go golang

Last synced: about 1 year ago
JSON representation

A command-line tool to interact with CasaOS for testing and diagnosing purpose

• Host: GitHub
• URL: https://github.com/icewhaletech/casaos-cli
• Owner: IceWhaleTech
• License: apache-2.0
• Created: 2022-11-11T16:43:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-16T06:19:27.000Z (about 1 year ago)
• Last Synced: 2025-04-16T07:57:42.725Z (about 1 year ago)
• Topics: cli, cobra-cli, go, golang
• Language: Go
• Homepage:
• Size: 119 KB
• Stars: 17
• Watchers: 4
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CasaOS-CLI

[![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)

A command-line tool to interact with CasaOS for testing and diagnosing purpose

## Usage

```text

A command line interface for CasaOS

Usage:

  casaos-cli [command]

Services

  app-management All compose app management and store related commands

  local-storage  All local storage related commands

  message-bus    All message bus related commands

Additional Commands:

  completion     Generate the autocompletion script for the specified shell

  help           Help about any command

  version        Show version

Flags:

  -h, --help              help for casaos-cli

  -u, --root-url string   root url of CasaOS API (default "localhost:80")

Additional help topics:

  casaos-cli gateway        All gateway related commands

  casaos-cli user           All user related commands

Use "casaos-cli [command] --help" for more information about a command.

```

## Contributing

Use  to add any new command.

Follow example steps below to add commands like `casaos-cli message-bus list event-types`

1. create command scaffold with `cobra-cli add`:

    ```shell

    go run github.com/spf13/cobra-cli@latest add messageBus --config .cobra.yaml

    go run github.com/spf13/cobra-cli@latest add messageBusList -p messageBusCmd --config .cobra.yaml

    go run github.com/spf13/cobra-cli@latest add messageBusListEventTypes -p messageBusListCmd --config .cobra.yaml

    ```

    > It is important to include `--config .cobra.yaml` to attribute the scaffold code with correct license header.

2. update each `messageBus*.go` file with correct command format:

    ```go

    // messageBus.go

    Use:   "messageBus",

    // messageBusList.go

    Use:   "messageBusList",

    // messageBusListEventTypes.go

    Use:   "messageBusListEventTypes",

    ```

    becomes

    ```go

    // messageBus.go

    Use:   "message-bus",

    // messageBusList.go

    Use:   "list",

    // messageBusListEventTypes.go

    Use:   "event-types",

    ```

3. update short and long description for each command, and implement the logics

4. to verify the commands are created correctly, run

    ```shell

    $ go run main.go message-bus list event-types --help

    list event types

    Usage:

    CasaOS-CLI message-bus list event-types [flags]

    Flags:

    -h, --help   help for event-types

    ```

> Run `go run github.com/spf13/cobra-cli@latest --help` to see additional help message.