# CasaOS-CLI

**Repository Path**: icewhale-team/CasaOS-CLI

## Basic Information

- **Project Name**: CasaOS-CLI
- **Description**: A command-line tool to interact with CasaOS for testing and diagnosing purpose 
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-12-27
- **Last Updated**: 2023-06-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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)

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]

Available Commands:
  completion    Generate the autocompletion script for the specified shell
  help          Help about any command
  local-storage All local storage related commands
  message-bus   All message bus related commands
  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 <https://github.com/spf13/cobra-cli> 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.