Skip to main content

​
Requirements

  • macOS or Linux, with a POSIX shell.
  • Node.js 20.19 or newer, and npm (it comes with Node.js).
  • curl or wget.
Check your Node.js version:

​
Install

The script:
  1. Checks for Node.js 20.19+ and npm.
  2. Downloads the CLI package and checks its SHA-256 checksum. If the checksum differs, nothing is installed.
  3. Installs the package into ~/.olostep. No sudo is needed.
  4. Links olostep into a writable directory that is already on your PATH. If there is none, it links into ~/.local/bin and adds that directory to your shell’s startup file (~/.zshrc, ~/.bashrc or ~/.bash_profile, fish’s conf.d, or ~/.profile).
When it finishes, it prints Installed olostep <version> in ~/.olostep/bin. If it had to change your PATH, open a new terminal first. Then run:

​
Install somewhere else

Set OLOSTEP_HOME to an absolute path to install there instead of ~/.olostep:
The script stops if another olostep command is already on your PATH and was not installed by this script. Remove the other one first, then run the script again. The older npm package olostep-cli is a separate, older tool and is not covered by these docs.

​
Update

Run:
olostep update runs the install script again: curl -fsSL https://cli.olostep.com | sh. Running the script yourself does the same thing. When a newer version is out, the CLI tells you after a command finishes:
The notice only appears for a person at a terminal. It is not shown to coding agents, when CI is set, or with --json.

​
Uninstall

1

Sign out

Olostep revokes this computer’s connection and the CLI forgets its sign-in. Skip this if you were never signed in.
2

Remove the linked command

This removes the olostep link the installer put on your PATH.
3

Remove the installation

Use your OLOSTEP_HOME path instead if you set one.
4

Remove the CLI's settings

This folder holds the saved sign-in and the olostep chat conversation reference.
If the installer added a PATH line to your shell’s startup file, it sits under the comment # olostep CLI. Delete both lines.