RepoMirrors
/
alertmanager
mirror of https://github.com/prometheus/alertmanager
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
alertmanager/cmd/amtool/README.md

21 lines
574 B
Markdown
Raw Normal View History

Amtool implementation (#636) * Implement alertmanager cli tool 'amtool' The primary goal of an alertmanager tool is to provide a cli interface for the prometheus alertmanager. My vision for this tool has two parts: - Silence management (query, add, delete) - Alert management (query, maybe more in future?) Resolves: #567
2017-04-20 09:04:17 +00:00
# Generating amtool artifacts
Switch amtool to kingpin (#976) * Switch cmd/amtool to kingpin * Touch-ups * Implement long help * Add missing short-form of --output * Fix backwards compatibility for config file options * Fix vendoring * Review fixes * Fix flag word order
2017-12-22 10:17:13 +00:00
Amtool comes with the option to create a number of ease-of-use artifacts that can be created.
Amtool implementation (#636) * Implement alertmanager cli tool 'amtool' The primary goal of an alertmanager tool is to provide a cli interface for the prometheus alertmanager. My vision for this tool has two parts: - Silence management (query, add, delete) - Alert management (query, maybe more in future?) Resolves: #567
2017-04-20 09:04:17 +00:00
Switch amtool to kingpin (#976) * Switch cmd/amtool to kingpin * Touch-ups * Implement long help * Add missing short-form of --output * Fix backwards compatibility for config file options * Fix vendoring * Review fixes * Fix flag word order
2017-12-22 10:17:13 +00:00
## Shell completion
Amtool implementation (#636) * Implement alertmanager cli tool 'amtool' The primary goal of an alertmanager tool is to provide a cli interface for the prometheus alertmanager. My vision for this tool has two parts: - Silence management (query, add, delete) - Alert management (query, maybe more in future?) Resolves: #567
2017-04-20 09:04:17 +00:00
Switch amtool to kingpin (#976) * Switch cmd/amtool to kingpin * Touch-ups * Implement long help * Add missing short-form of --output * Fix backwards compatibility for config file options * Fix vendoring * Review fixes * Fix flag word order
2017-12-22 10:17:13 +00:00
A bash completion script can be generated by calling `amtool --completion-script-bash`.
Amtool implementation (#636) * Implement alertmanager cli tool 'amtool' The primary goal of an alertmanager tool is to provide a cli interface for the prometheus alertmanager. My vision for this tool has two parts: - Silence management (query, add, delete) - Alert management (query, maybe more in future?) Resolves: #567
2017-04-20 09:04:17 +00:00
The bash completion file can be added to `/etc/bash_completion.d/`.
## Man pages
Switch amtool to kingpin (#976) * Switch cmd/amtool to kingpin * Touch-ups * Implement long help * Add missing short-form of --output * Fix backwards compatibility for config file options * Fix vendoring * Review fixes * Fix flag word order
2017-12-22 10:17:13 +00:00
A man page can be generated by calling `amtool --help-man`.
Amtool implementation (#636) * Implement alertmanager cli tool 'amtool' The primary goal of an alertmanager tool is to provide a cli interface for the prometheus alertmanager. My vision for this tool has two parts: - Silence management (query, add, delete) - Alert management (query, maybe more in future?) Resolves: #567
2017-04-20 09:04:17 +00:00
Man pages can be added to the man directory of your choice
Switch amtool to kingpin (#976) * Switch cmd/amtool to kingpin * Touch-ups * Implement long help * Add missing short-form of --output * Fix backwards compatibility for config file options * Fix vendoring * Review fixes * Fix flag word order
2017-12-22 10:17:13 +00:00
amtool --help-man > /usr/local/share/man/man1/amtool.1
Amtool implementation (#636) * Implement alertmanager cli tool 'amtool' The primary goal of an alertmanager tool is to provide a cli interface for the prometheus alertmanager. My vision for this tool has two parts: - Silence management (query, add, delete) - Alert management (query, maybe more in future?) Resolves: #567
2017-04-20 09:04:17 +00:00
sudo mandb
Then you should be able to view the man pages as expected.