Usage Examples
The aim of the toolbelt is to be easy to use.
After having installed the toolbelt you can simply call the argus-cli
command. After installation this should have been added to your path. On a Linux
machine, simply type argus-cli
in your terminal, and on a Windows machine
you’ll have to type argus-cli.exe
in your terminal.
Argus CLI has a plugin-architecture, with the possibility to add deep plugins. This is reflected in the way you use the command. The command starts of with the plugin you want to use, then you specify the command under that plugin. After that you’ll supply your arguments.
argus-cli <plugin [sub-plugin [...]]> <command> [arguments]
If you’re wondering what commands (or plugins) are available under a specified
plugin, simply use the --help
on the plugin (or the root command).
There is also an aim to standardize how inputs are handled, thus you’ll find that most commands have the same input format for time, dates, etc.
Examples
Running a custom created command
To get statistics about cases you can use the cases statistics
command.
In this example cases
is the plugin while statistics
is the command.
Here we’re getting statistics for a month for mnemonic. Dates follow ISO8061.
argus-cli cases statistics "2017-01-01" "2017-02-01" --customer mnemonic
Calling the API
Another aim of the toolbelt is to be able to call all APIs without having to create custom scripts or use cumbersome curl commands. It’s worth noting that API calls don’t supply other formatting than JSON output and raw inputs (eg. unix timestamps for date and time).
In this example we’re searching for cases containing the keywords “Email containing malicious data” for customer 1.
argus-cli cases v2 case simple-case-search --keywords "Malware"