---
title: "Command Line Interface — WindKeep"
description: "WindKeep Command Line Interface."
canonical_url: "https://windkeep.up.railway.app/cli-guide"
meta:
  "og:description": "WindKeep Command Line Interface."
  "og:image": "https://windkeep.up.railway.app/og-image.png"
  "og:title": "Command Line Interface — WindKeep"
---

> Index of every page on this site: [llms.txt](https://windkeep.up.railway.app/llms.txt)

# Command Line Interface

## Overview

The WindKeep CLI lets you manage secrets, organizations, and projects from your terminal. It is the fastest way to create projects, rotate keys, and run local commands with injected environment variables — without maintaining `.env` files.

*You can use `wk` as a shortcut for `windkeep`.*

## Quick Installation

Run the install script for your platform. It downloads the binary and updates your PATH.

*Restart your terminal after installing, then run `windkeep --version` to verify.*

**Linux**

```
curl -sSL https://windkeep.up.railway.app/install/install.sh | bash
```

**Windows (PowerShell)**

```
irm https://windkeep.up.railway.app/install/install.ps1 | iex
```

## Install via Go

If you already have Go installed, you can build and install the CLI from source. The binary is placed in your Go bin directory (`$GOBIN`, `$GOPATH/bin`, or `~/go/bin` by default) — make sure that directory is on your PATH.

*This method does not set up the `wk` shortcut.*

```
go install github.com/matimortari/windkeep/cli@latest
```

## Authentication

Interactive use: authenticate with your **personal API token** from the [preferences page](https://windkeep.up.railway.app/admin/preferences).

CI/CD: use a project **service token** (`st_…`) from Access Control, or set `WINDKEEP_TOKEN` and `WINDKEEP_PROJECT_ID` in the environment — see Guides → CI/CD.

*Login validates your token and saves credentials to `~/.config/windkeep/config.yml` (Linux) or `%APPDATA%\windkeep\config.yml` (Windows).*

```
# Personal token — full CLI access
windkeep login YOUR_API_TOKEN

# Service token — read-only, single project (CI-friendly)
windkeep login st_YOUR_SERVICE_TOKEN

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

# Show your user or service-token context
windkeep whoami

# Remove stored credentials
windkeep logout
```

## Upgrading

Download and install the latest CLI release in place.

*On Windows, run `windkeep --version` after upgrading to finish the installation.*

```
windkeep upgrade
```

## Next Steps

- [**Organizations & Projects**](https://windkeep.up.railway.app/cli-guide/orgs-projects): Manage workspaces and project containers.
- [**Secrets Management**](https://windkeep.up.railway.app/cli-guide/secrets): Create secrets and use windkeep run.
- [**Guides & Troubleshooting**](https://windkeep.up.railway.app/cli-guide/guides): Workflows and common fixes.

```json
{"@context":"https://schema.org","@graph":[{"@id":"https://windkeep.up.railway.app/#website","@type":"WebSite","name":"WindKeep","url":"https://windkeep.up.railway.app/"},{"@id":"https://windkeep.up.railway.app/cli-guide/#webpage","@type":"WebPage","description":"WindKeep Command Line Interface.","name":"Command Line Interface","url":"https://windkeep.up.railway.app/cli-guide/","isPartOf":{"@id":"https://windkeep.up.railway.app/#website"},"potentialAction":[{"@type":"ReadAction","target":["https://windkeep.up.railway.app/cli-guide/"]}]}]}
```

## Sitemap

See the full [sitemap](https://windkeep.up.railway.app/sitemap.md) for all pages.
