# README
STACKIT ARGUS CLI
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.
Whenever you need help regarding the available actions, just use the following command.
make help
Usage
Installation
From source
If you have Go on your machine, you can directly install by running:
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. Rungo 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. Make the file executable and place it in a directory available in your $PATH.
Configuration
To set up configurations run:
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.
To update the generated code, run:
make generate-client-code
Setup
To get your setup up and running the only thing you have to do is
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
make lint
Run tests
make test