Line data    Source code

       1           0 : \cond NEVER
       2             : Distributed under the MIT License.
       3             : See LICENSE.txt for details.
       4             : \endcond
       5             : # Command-line interface (CLI) {#tutorial_cli}
       6             : 
       7             : \tableofcontents
       8             : 
       9             : SpECTRE has a command-line interface (CLI) that allows you to run executables,
      10             : work with output data, and generate plots and visualizations. To get started,
      11             : compile the `cli` target in your build directory. Then run:
      12             : 
      13             : ```sh
      14             : ./bin/spectre --help
      15             : ```
      16             : 
      17             : All available commands are listed in the [Python documentation](py/cli.html).
      18             : 
      19             : ## Autocompletion
      20             : 
      21             : The CLI supports autocompletion for Bash, Zsh, and Fish. Depending on your
      22             : shell, source the corresponding file:
      23             : 
      24             : ```sh
      25             : # In the build directory:
      26             : # - Bash:
      27             : . ./bin/python/shell-completion.bash
      28             : # - Fish:
      29             : cp ./bin/python/shell-completion.fish ~/.config/fish/completions/spectre.fish
      30             : # - Zsh:
      31             : . ./bin/python/shell-completion.zsh
      32             : ```
      33             : 
      34             : You may want to source the shell completion script on startup, e.g., in your
      35             : `.bashrc` or `.zshrc` file.