Command Line Interface

The WindKeep Command Line Interface allows you to manage secrets, organizations, and projects directly from your terminal. Fast, secure, and designed for developers who prefer working in the command line.

Installation

Shell Script (Linux / macOS)

curl -sSL https://windkeep.vercel.app/install/install.sh | bash

PowerShell Script (Windows)

irm https://windkeep.vercel.app/install/install.ps1 | iex

Manual Download

Installation Steps

Linux / macOS:

  1. Download the binary for your system
  2. Open terminal and navigate to downloads: cd ~/Downloads
  3. Make it executable: chmod +x windkeep-*
  4. Move to PATH: sudo mv windkeep-* /usr/local/bin/windkeep
  5. Verify: windkeep --version

Windows:

  1. Download the .exe file
  2. Move it to a directory in your PATH
  3. Open PowerShell and verify: windkeep --version

Authentication

First, sign in to WindKeep and retrieve your API token:

  1. Navigate to your preferences page
  2. Copy your API token
  3. Run the login command:
# Pass token as argument
windkeep login YOUR_API_TOKEN

# Or use interactive mode (token input will be hidden)
windkeep login

This validates your token and saves your configuration in ~/.windkeep/config.yaml.

Logout

Remove stored authentication credentials by running:

windkeep logout

This deletes your local configuration file. You'll need to run windkeep login again to use the CLI.

Utility Commands

windkeep whoami

Display information about your currently authenticated user and active context.

Example:

windkeep whoami

windkeep upgrade

Upgrade the WindKeep CLI to the latest version.

Example:

windkeep upgrade

This downloads and installs the latest version for your operating system.

Advanced: Use --config flag to specify a custom configuration file location (default: ~/.windkeep/config.yaml).

Next Steps

Now that you're set up, explore the documentation: