> ## Documentation Index
> Fetch the complete documentation index at: https://docs.krypthq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with Krypt in under 5 minutes

Krypt manages your environment variables across teams with end-to-end encryption. By the end of this guide you'll have the CLI installed, a project linked, and your first secrets pushed.

<Note>
  You need a free [Krypt account](https://krypthq.com/signup) and Node.js 20 or newer to follow along.
</Note>

<Steps>
  <Step title="Install the CLI">
    <Tabs>
      <Tab title="npm">
        ```bash theme={null}
        npm install -g @kryptorg/cli
        ```
      </Tab>

      <Tab title="yarn">
        ```bash theme={null}
        yarn global add @kryptorg/cli
        ```
      </Tab>

      <Tab title="pnpm">
        ```bash theme={null}
        pnpm add -g @kryptorg/cli
        ```
      </Tab>
    </Tabs>

    <Tip>
      Getting a permission error? Run the command with `sudo` (macOS/Linux) or open your terminal as Administrator (Windows).

      ```bash theme={null}
      sudo npm install -g @kryptorg/cli
      ```
    </Tip>

    Verify the install:

    ```bash theme={null}
    krypt --version
    ```

    Expected output:

    ```text theme={null}
    2.1.1
    ```
  </Step>

  <Step title="Generate an API key">
    1. Open the [API keys page](https://krypthq.com/dashboard/api-keys) in your Krypt dashboard
    2. Click **Generate Key**
    3. Name it after where you'll use it — e.g. "my-laptop", "production-ci", "teammate-bob"
    4. Copy the key — it starts with `krypt_live_` and is shown only once
  </Step>

  <Step title="Log in from your terminal">
    ```bash theme={null}
    krypt login --key krypt_live_<your-key>
    ```

    You should see:

    ```text theme={null}
    ✓ API key verified
      Config saved to ~/.krypt/config.json
    ```
  </Step>

  <Step title="Create a project">
    In your [Krypt dashboard](https://krypthq.com/dashboard):

    1. Click **New Project**
    2. Name it `my-app`
    3. Save
  </Step>

  <Step title="Link your local folder">
    Inside your project directory, run:

    ```bash theme={null}
    krypt init my-app
    ```

    This creates a `.krypt` config file that links the folder to your Krypt project.
  </Step>

  <Step title="Push your first secrets">
    If you already have a `.env` file, push it directly:

    ```bash theme={null}
    krypt push
    ```

    Or create one first:

    ```bash theme={null}
    echo "DATABASE_URL=postgres://localhost:5432/mydb" > .env
    echo "API_TOKEN=secret-value" >> .env
    krypt push
    ```

    You should see:

    ```text theme={null}
    ✓ Pushed 2 secret(s) to "my-app" (development)
    ```

    Your secrets are now encrypted and stored in Krypt.
  </Step>

  <Step title="Pull secrets on another machine">
    If you're working on multiple machines or setting up CI/CD, run `krypt pull` to fetch the latest secrets:

    ```bash theme={null}
    krypt pull
    ```

    Krypt fetches your encrypted secrets and writes them to `.env`.
  </Step>

  <Step title="Run a command with injected secrets">
    Instead of writing a `.env` file, inject secrets directly into a process:

    ```bash theme={null}
    krypt run -- node server.js
    ```

    Krypt loads your secrets as environment variables and starts the command. No `.env` file needed.
  </Step>
</Steps>

## What's next

Got Krypt running? Next, learn about the [CLI commands](/cli/commands), how to [organize secrets across environments](/concepts/projects-and-environments), or [share projects with your team](/concepts/roles-and-permissions). These pages are being expanded — contact [support@krypthq.com](mailto:support@krypthq.com) if you need help in the meantime.