Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
llavaud committed Jan 1, 2017
1 parent 57c9e08 commit bfa4ad6
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Kibana Backup Tool
# kbt - Kibana Backup Tool

This script allow to list and export kibana resources like search, visualization and dashboard.
This script allow to list, export and import kibana resources (search, visualization and dashboard).

You can export everything you want from Kibana interface, but if you want to setup a cronjob to do regular backup or just do it in CLI, this is the right tool to use.

Expand Down Expand Up @@ -52,13 +52,16 @@ Once the packages are installed, you just need to extract the archive
kbt [OPTIONS] <COMMAND>
OPTIONS
--type TYPE Type of kibana resources {search|visualization|dashboard} (defaults to all)
--output FILE Backup file (defaults to kbt_export.json)
--host IP:PORT Ip address of elasticsearch instance (defaults to localhost:9200)
--index INDEX Kibana index (defaults to .kibana)
--file FILE Backup file to import (defaults to kbt_export.json)
--help Print this help
--host IP:PORT Ip address of elasticsearch instance (defaults to localhost:9200)
--index INDEX Kibana index (defaults to .kibana)
--output FILE Backup file (defaults to kbt_export.json)
--overwrite Overwrite existing documents during import (default is to skip existing docs)
--type TYPE Type of kibana resources {search|visualization|dashboard} (defaults to all)
COMMAND
list list resource's id
export export resources
import import resources
```

0 comments on commit bfa4ad6

Please sign in to comment.