Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sgaunet/zabbix-cli

zabbix-cli is a command line tool to interact with Zabbix API.
https://github.com/sgaunet/zabbix-cli

api cli export import templates zabbix

Last synced: 14 days ago
JSON representation

zabbix-cli is a command line tool to interact with Zabbix API.

Host: GitHub
URL: https://github.com/sgaunet/zabbix-cli
Owner: sgaunet
License: mit
Created: 2024-10-21T15:10:49.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-11-17T21:00:15.000Z (about 1 month ago)
Last Synced: 2024-11-29T05:41:01.250Z (26 days ago)
Topics: api, cli, export, import, templates, zabbix
Language: Go
Homepage:
Size: 57.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![GitHub release](https://img.shields.io/github/release/sgaunet/zabbix-cli.svg)](https://github.com/sgaunet/zabbix-cli/releases/latest)

[![Go Report Card](https://goreportcard.com/badge/github.com/sgaunet/zabbix-cli)](https://goreportcard.com/report/github.com/sgaunet/zabbix-cli)

![GitHub Downloads](https://img.shields.io/github/downloads/sgaunet/zabbix-cli/total)

[![Maintainability](https://api.codeclimate.com/v1/badges/8412fedc31a7892cd92a/maintainability)](https://codeclimate.com/github/sgaunet/zabbix-cli/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/8412fedc31a7892cd92a/test_coverage)](https://codeclimate.com/github/sgaunet/zabbix-cli/test_coverage)

[![GoDoc](https://godoc.org/github.com/sgaunet/zabbix-cli?status.svg)](https://godoc.org/github.com/sgaunet/zabbix-cli)

[![License](https://img.shields.io/github/license/sgaunet/zabbix-cli.svg)](LICENSE)

# zabbix-cli

zabbix-cli is a command line tool to interact with Zabbix API.

**It is a work in progress.**

## Features

- Export templates YAML

- Import templates YAML

## zabbix API

The API documentation is available [here](https://www.zabbix.com/documentation/6.0/en/manual/api/reference/configuration/export).

## Getting started

Usage is quite simple :

```bash

A CLI tool to interact with Zabbix API

Usage:

  zabbix-cli [command]

Available Commands:

  config      describes how to configure zabbix-cli

  export      export template

  help        Help about any command

  import      import template

  version     print version of zabbix-cli

Flags:

  -h, --help   help for zabbix-cli

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

```

## Install

### From binary

Download the binary in the release section.

### From Docker image

Docker registry is: sgaunet/zabbix-cli

- The docker image is multi-arch

- It contains only the binary, use multi stage build to copy zabbix-cli in your image

```Dockerfile

FROM sgaunet/zabbix-cli:latest as zabbix-cli

FROM alpine:latest

COPY --from=zabbix-cli /usr/bin/zabbix-cli /usr/local/bin/zabbix-cli

```

## Development

This project is using:

- golang

- [task for development](https://taskfile.dev/#/)

- docker

- [docker buildx](https://github.com/docker/buildx)

- docker manifest

- [goreleaser](https://goreleaser.com/)

- [venom](https://github.com/ovh/venom) : Tests

- [pre-commit](https://pre-commit.com/)

There are hooks executed in the precommit stage. Once the project cloned on your disk, please install pre-commit:

```bash

brew install pre-commit

```

Install tools:

```bash

task dev:install-prereq

```

And install the hooks:

```bash

task dev:install-pre-commit

```

If you like to launch manually the pre-commmit hook:

```bash

task dev:pre-commit

```

## Tests

Tests are done with [venom](https://github.com/ovh/venom).

```bash

cd tests

docker compose up -d

# Check that the stack is up before running the tests

task tests

```