astra shellenv

astra shellenv [--ignore-multiple-paths] [--no-update-notifier]
               [--home=<$home>] [--rc=<$rc>]

Completions, configuration, and more

Eval-ing the output of this command will:

  • Add the binary to your PATH

  • Enable shell completions

  • Optionally set any other configuration environment variables.

Intended to be added to your shell profile (.zprofile, .bash_profile, .profile, etc.), but you can technically just eval it in any shell session to get completions and update your PATH for that session.

Options

--home

Sets the ASTRA_HOME env var. See astra config home path -h for how this is resolved.

--rc

Sets the ASTRARC env var. See astra config path -h for how this is resolved.

--ignore-multiple-paths

Ignore warnings about multiple astra home folders or astrarc files being present. Sets ASTRA_IGNORE_MULTIPLE_PATHS=true under the hood.

--no-update-notifier

Disables background update checks notifications. Sets ASTRA_NO_UPDATE_NOTIFIER=true under the hood.

Examples

# Put this in your shell profile (e.g. ``~/.zprofile``) to generate completions and set your PATH
$ eval "$(/path/to/astra shellenv)"

# Set a custom ``ASTRA_HOME`` path
$ eval "$(/path/to/astra shellenv --home /path/to/astra/home)"

# Set a custom ``ASTRARC`` path
$ eval "$(/path/to/astra shellenv --rc /path/to/astrarc)"

# Disable update notifications
$ eval "$(/path/to/astra shellenv --no-update-notifier)"

# Ignore warnings about multiple astra home folders or astrarc files
$ eval "$(/path/to/astra shellenv --ignore-multiple-paths)"

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2025 | Privacy policy | Terms of use Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM