Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Most of the configuration is done out of the box.

Setting up a local config file

The toolbelt looks for a local config file called .argus_cli.yaml in your home directory.

Code Block
languagebash
$ touch ~/.argus_cli.yaml
$ chmod 600 ~/.argus_cli.yaml

Config fields

Argus API

All argus_api options exist under the api field in the YAML-file.

Alternative API URL

To add your own custom argus-url, you have to use the api_url parameter.

...

Code Block
api:
	api_url: <Your API URL>


Authentication

To use some functions in the API you'll have to be authenticated.

This can for example be done by SMS confirmation, username and password or API keys. It's recommended to use an API key.

API Key
Code Block
api:
	api_key: <Your API Key>
	method: apikey
Username and password
Code Block
api:
	username: <Your username>
	password: <Your password>
	method: username

Argus CLI

Adding custom commands

To add your own custom written commands to the toolbelt, you simply have to add another set of lines to your config.

...

To see more on how to develop your own plugins, see Development Documentation.

Logging

The toolbelt utilizes pythons built in logging. This has it's own config format. To get more information about it look at the python documentation.

Changing logging level

The following is how to change the logging level of the program. Examples are DEBUG, INFO, WARNING and ERROR.

...