The Re:infer Command Line Interface,
re, is a unified
tool that provides a consistent interface for interacting with all parts of
Re:infer from a terminal.
re simplifies managing Re:infer resources, such as sources and datasets, as
well as importing or exporting communications data. Additionally,
multiple contexts, making it easy to switch between multiple authentication
tokens for different users, service accounts or Re:infer endpoints.
The Re:infer CLI is open source and developed on GitHub.
- Create, get, update and delete operations for all the different Re:infer resources. This includes sources, datasets, comments, buckets, streams and more.
- Context management for multiple API tokens and Re:infer endpoints.
- Easily upload new verbatims to a source.
- Download verbatims from a set of sources and datasets together with the human applied annotations. Useful for backups, migrating data or for applying some transformations to the data.
- Basic shell autocompletion for
bash, colorized terminal output, progress bars and more
Statically linked binaries with no dependencies are provided for all major platforms
To build from source, you need a recent version of the Rust toolchain installed. To install using cargo
cargo install --locked reinfer-cli
Ensure you have the cargo bin directory in your path (typically
Alternatively, you can always clone the repository and build it with
The Re:infer CLI ships with a lot of command documentation that is accessible
$ re --help
$ re <command> --help
$ re <command> <subcommand> --help
We encourgage you to use read the included documentation as it's extensive and always up to date.
$ re --help
re is the command line interface to reinfer clusters
re [FLAGS] [OPTIONS] <SUBCOMMAND>
-h, --help Prints help information
-V, --version Prints version information
-v, --verbose Enable more verbose logging
-k, --accept-invalid-certificates <accept-invalid-certificates>
Path to the configuration file. Typically defaults to ~/.config/reinfer on Linux
-c, --context <context>
Specify what context to use. Overrides the current context, if any
Specify what endpoint to use. Overrides the one from the current context, if any
-o, --output <output>
Output format. One of: json, table [default: table]
URL for an HTTP proxy that will be used for all requests if specified
Specify what API token to use. Overrides the one from the current context, if any
completion Output shell completion code for the specified shell (bash or zsh)
config Manage reinfer authentication and endpoint contexts
create Create new resources
delete Delete a resource
get Display resources and export comments to the local filesystem
help Prints this message or the help of the given subcommand(s)
update Update existing resources
To troubleshoot issues with the Re:infer CLI, the following may be useful
- Make sure the latest version of
reis installed. Get the installed version by running
--verboseflag prints debugging messages, which may narrow down the issue.
- Connection issues may be due to improperly configured proxy settings. See Using a Proxy to configure request proxying.
- The Re:infer CLI configuration directory is system specific, e.g.
~/.config/reinferon Linux or macOS and
%AppData%/reinferon Windows. It can safely be deleted and the CLI will repopulate it, but all configuration (including user sessions) will be lost.
If there is anything you feel we can do to improve it or if you encounter any bugs or unexpected behaviour, please let us know at email@example.com.