This document covers how to configure the toolbeltargus-cli. Most of the configuration is done out of the box, but in some cases you might want to do some more configuration.
Table of Contents |
---|
Setting up a local config file
...
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.
Code Block |
---|
cli:
plugins:
- <plugin folder>
- <plugin folder>
- <[...]>
|
...
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.
...
Code Block |
---|
logging: loggers: argus_api: level: <LOGGING LEVEL> argus_cli: level: <LOGGING LEVEL> |
Environments
In some cases, you might want to change between different configuration environments. For example, you might want to use a different API key for some special scripts. This is where environments come in.
In an environment, you'll be using the baseline config that you've defined at the top level as a base, and work on top of that. Any keys you specify will be overwritten, others will be used as is.
These environments exist under the environment.<name> tag in your config, and can be used with the --environment option in the cli.
Code Block |
---|
environment:
test:
api:
api_key: 123/45/abcdefg
method: apikey |
With this example, you can use your environment like this:
Code Block |
---|
argus-cli --environment test <your command here> |