Docs / Getting Started

Getting Started

This guide walks you through installing SlickEnv, authenticating, and pushing your first environment. The whole process takes under two minutes.

1. Install the CLI

Install the CLI globally via npm. Works on macOS, Linux, and Windows via WSL.

$ npm install -g slickenv

Alternatively, install via Homebrew or run directly with npx:

$ brew install slickenv/tap/slickenv
# or run without installing
$ npx slickenv

Verify the installation:

$ slickenv --version
slickenv 1.0.0

Sign in with your GitHub or Google account. The CLI opens your browser for OAuth and stores the token securely in your system keychain.

$ slickenv login
→ Opening browser for authentication...
✓ Authenticated as you@example.com

Navigate to your project directory and run init. This links the directory to a SlickEnv project and environment.

$ cd my-project
$ slickenv init
? Project name: my-project
? Environment: development
✓ Initialised — linked to my-project/development

This creates a small .slickenv config file in your project root. Add it to your .gitignore.

Push your local .env file to SlickEnv. It is encrypted, versioned, and stored securely.

$ slickenv push
✓ Pushed 14 variables — version 1 created.

On a new machine or after cloning the repo, authenticate and pull. The latest environment is written to your local .env file.

$ slickenv login
$ slickenv pull
✓ Pulled version 1 — .env updated with 14 variables.