Skip to content

Commit

Permalink
docs: Improve installation instructions and usage details
Browse files Browse the repository at this point in the history
- Added instructions for installing Qase CLI via `go install`
- Updated Docker installation steps for clarity
- Enhanced documentation with clearer usage guidelines and command details

#57
  • Loading branch information
gibiw committed Dec 12, 2024
1 parent f250ecd commit f59535c
Showing 1 changed file with 43 additions and 23 deletions.
66 changes: 43 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,64 @@
# Qase CLI

`qli` is Qase on the command line. It allows you to work with test runs and import test results.
`qli` is the command-line interface (CLI) for Qase, enabling users to interact with test runs and import test results
directly from the terminal.

Qase CLI is available for Qase and Qase Enterprise users.
Qase CLI is available for both **Qase** and **Qase Enterprise** users.

# Installation
## Installation

## Build from source
### Install via `go install`

1. Clone the repository
The easiest way to install Qase CLI is using `go install`:

```bash
git clone https://github.com/qase-tms/qasectl.git && cd qasectl
go install github.com/qase-tms/qasectl@latest
```

2. Build the binary
Make sure to add `$GOPATH/bin` to your `$PATH` environment variable to be able to run the `qasectl` command.

```bash
make build
```
### Build from Source

You will find the binary in the `build` directory.
If you'd like to build the CLI from source, follow these steps:

## Docker image
1. Clone the repository:

1. Pull the Docker image
```bash
git clone https://github.com/qase-tms/qasectl.git && cd qasectl
```

```bash
docker pull ghcr.io/qase-tms/qase-cli:latest
```
2. Build the binary using `make`:

```bash
make build
```

The compiled binary will be located in the `build` directory.

### Docker Image

2. Run the Docker container
You can also use Qase CLI via Docker. Follow these steps:

1. Pull the latest Docker image:

```bash
docker pull ghcr.io/qase-tms/qase-cli:latest
```

2. Run the Docker container:

```bash
docker run --rm ghcr.io/qase-tms/qase-cli:latest version
```

## Usage

`qli` is designed to be used directly in your terminal. You can run the following command to view available options:

```bash
docker run --rm ghcr.io/qase-tms/qase-cli:latest version
qli --help
```

# Usage

The tool is designed to be used in a terminal.
You can run `qli` with the `--help` flag to see the available commands and options.
This will show all available commands and their descriptions.

You can find more information about the commands and options in the [documentation](docs/command.md).
For more detailed information about each command and option, refer to the [full documentation](docs/command.md).

0 comments on commit f59535c

Please sign in to comment.