Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pederhan committed Aug 22, 2024
1 parent d536540 commit 9fbd35d
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ zabbix-cli

#### Formats

Zabbix-cli supports two output formats: table and JSON. The default format is table, but it can be changed with the `--format` parameter or by setting the `app.output_format` parameter in the config file.
Zabbix-cli supports two output formats: table and JSON. The default format is table, but it can be changed with the `--format` parameter:

```bash
# Show hosts in table format (default)
Expand All @@ -51,6 +51,13 @@ zabbix-cli --format json show_hosts
> --format json show_hosts
```

Or by setting the `app.output_format` parameter in the config file:

```toml
[app]
output_format = "json"
```

### Usage

Zabbix-cli is a command line interface for Zabbix. It can be used in three ways:
Expand Down Expand Up @@ -221,6 +228,14 @@ hatch shell

This will create a new virtual environment, install the required dependencies and enter the environment.

If you do not wish to use Hatch, you can create a virtual environment manually:

```bash
python -m venv .venv
source .venv/bin/activate
pip install -U -e ".[test]"
```

### Testing

Run unit tests (without coverage):
Expand Down

0 comments on commit 9fbd35d

Please sign in to comment.