AlgoKit Completions

AlgoKit supports shell completions for zsh and bash shells, e.g.

bash

1
$ algokit <Press Tab>
2
bootstrap    completions  config       doctor       explore      goal         init         sandbox

zsh

1
$ ~ algokit <Press Tab>
2
bootstrap    -- Bootstrap AlgoKit project dependencies.
3
completions  -- Install and Uninstall AlgoKit shell integration.
4
config       -- Configure AlgoKit options.
5
doctor       -- Run the Algorand doctor CLI.
6
explore      -- Explore the specified network in the...
7
goal         -- Run the Algorand goal CLI against the AlgoKit Sandbox.
8
init         -- Initializes a new project.
9
sandbox      -- Manage the AlgoKit sandbox.

Installing

To setup the completions, AlgoKit provides commands that will modify the current users interactive shell script (.bashrc/.zshrc).

Note If you would prefer AlgoKit to not modify your interactive shell scripts you can install the completions yourself by following the instructions here.

To install completions for the current shell execute algokit completions install. You should see output similar to below:

1
$ ~ algokit completions install
2
AlgoKit completions installed for zsh 🎉
3
Restart shell or run `. ~/.zshrc` to enable completions

After installing the completions don’t forget to restart the shell to begin using them!

Uninstalling

To uninstall completions for the current shell run algokit completions uninstall:

1
$ ~ algokit completions uninstall
2
AlgoKit completions uninstalled for zsh 🎉

Shell Option

To install/uninstall the completions for a specific shell the --shell option can be used e.g. algokit completions install --shell bash.

To learn more about the algokit completions command, please refer to completions in the AlgoKit CLI reference documentation.