https://github.com/stackitcloud/stackit-argus-cli
https://github.com/stackitcloud/stackit-argus-cli
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/stackitcloud/stackit-argus-cli
- Owner: stackitcloud
- Created: 2022-07-28T12:30:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-11T15:31:52.000Z (over 2 years ago)
- Last Synced: 2025-12-24T07:55:57.490Z (4 months ago)
- Language: Go
- Size: 77.2 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# STACKIT ARGUS CLI
[](https://github.com/SchwarzIT/go-template)
CLI for interacting with STACKIT ARGUS API.
The project uses `make` to make your life easier. If you're not familiar with Makefiles you can take a look at [this quickstart guide](https://makefiletutorial.com).
Whenever you need help regarding the available actions, just use the following command.
```bash
make help
```
# Usage
## Installation
### From source
If you have Go on your machine, you can directly install by running:
```bash
go install github.com/stackitcloud/stackit-argus-cli/cmd/stackit-argus-cli@latest
```
> Based on your go configuration the `stackit-argus-cli` binary can be found in `$GOPATH/bin` or `$HOME/go/bin` in case `$GOPATH` is not set. Make sure to add the respective directory to your `$PATH`. [For more information see go docs](https://go.dev/ref/mod#go-install). Run `go env` to view your current configuration.
### From the released binaries
Download the desired version for your operating system and processor architecture from the [STACKIT ARGUS CLI](https://github.com/stackitcloud/stackit-argus-cli/releases/tag/v1.0.3). Make the file executable and place it in a directory available in your $PATH.
## Configuration
To set up configurations run:
```bash
statckit-argus-cli configure
```
After that configuration file(.stackit-argus-cli.yaml) will be generated in your $HOME directory.
## Update Client
The Client will be generated through the OpenAPI Spec file from ARGUS with [openapi-generator.tech](https://openapi-generator.tech/).
To update the generated code, run:
```bash
make generate-client-code
```
## Setup
To get your setup up and running the only thing you have to do is
```bash
make
```
This will initialize a git repo, download the dependencies in the latest versions, install all needed tools and generate binary in "./out/bin" directory.
## Test & lint
Run linting
```bash
make lint
```
Run tests
```bash
make test
```