Skip to content

Commit e457582

Browse files
stephnanguestephnangue
authored
docs: add PATH export step to provider README quickstart instructions (#83)
The downloaded binary is not on PATH by default, so bare `warden` commands fail. Add an explicit `export PATH` step after downloading and renumber subsequent steps.
1 parent cc224ec commit e457582

File tree

9 files changed

+72
-27
lines changed

9 files changed

+72
-27
lines changed

‎provider/anthropic/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,17 @@ The Anthropic provider enables proxied access to the Anthropic API through Warde
4343
> curl -L https://github.com/stephnangue/warden/releases/latest/download/warden_$(curl -s https://api.github.com/repos/stephnangue/warden/releases/latest | grep tag_name | cut -d '"' -f4 | tr -d v)_linux_arm64.tar.gz | tar xz
4444
> ```
4545
>
46-
> **3. Start the Warden server** in dev mode:
46+
> **3. Add the binary to your PATH:**
4747
> ```bash
48-
> ./warden server --dev
48+
> export PATH="$PWD:$PATH"
4949
> ```
5050
>
51-
> **4. In another terminal window**, export the environment variables for the CLI:
51+
> **4. Start the Warden server** in dev mode:
52+
> ```bash
53+
> warden server --dev
54+
> ```
55+
>
56+
> **5. In another terminal window**, export the environment variables for the CLI:
5257
> ```bash
5358
> export WARDEN_ADDR="http://127.0.0.1:8400"
5459
> export WARDEN_TOKEN="<your-token>"

‎provider/aws/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,17 @@ The AWS provider enables proxied access to AWS services through Warden. It inter
4747
> curl -L https://github.com/stephnangue/warden/releases/latest/download/warden_$(curl -s https://api.github.com/repos/stephnangue/warden/releases/latest | grep tag_name | cut -d '"' -f4 | tr -d v)_linux_arm64.tar.gz | tar xz
4848
> ```
4949
>
50-
> **3. Start the Warden server** in dev mode:
50+
> **3. Add the binary to your PATH:**
5151
> ```bash
52-
> ./warden server --dev
52+
> export PATH="$PWD:$PATH"
5353
> ```
5454
>
55-
> **4. In another terminal window**, export the environment variables for the CLI:
55+
> **4. Start the Warden server** in dev mode:
56+
> ```bash
57+
> warden server --dev
58+
> ```
59+
>
60+
> **5. In another terminal window**, export the environment variables for the CLI:
5661
> ```bash
5762
> export WARDEN_ADDR="http://127.0.0.1:8400"
5863
> export WARDEN_TOKEN="<your-token>"

‎provider/azure/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,17 @@ The Azure provider enables proxied access to Azure APIs through Warden. It manag
4444
> curl -L https://github.com/stephnangue/warden/releases/latest/download/warden_$(curl -s https://api.github.com/repos/stephnangue/warden/releases/latest | grep tag_name | cut -d '"' -f4 | tr -d v)_linux_arm64.tar.gz | tar xz
4545
> ```
4646
>
47-
> **3. Start the Warden server** in dev mode:
47+
> **3. Add the binary to your PATH:**
4848
> ```bash
49-
> ./warden server --dev
49+
> export PATH="$PWD:$PATH"
5050
> ```
5151
>
52-
> **4. In another terminal window**, export the environment variables for the CLI:
52+
> **4. Start the Warden server** in dev mode:
53+
> ```bash
54+
> warden server --dev
55+
> ```
56+
>
57+
> **5. In another terminal window**, export the environment variables for the CLI:
5358
> ```bash
5459
> export WARDEN_ADDR="http://127.0.0.1:8400"
5560
> export WARDEN_TOKEN="<your-token>"

‎provider/gcp/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,17 @@ The GCP provider enables proxied access to Google Cloud Platform APIs through Wa
4343
> curl -L https://github.com/stephnangue/warden/releases/latest/download/warden_$(curl -s https://api.github.com/repos/stephnangue/warden/releases/latest | grep tag_name | cut -d '"' -f4 | tr -d v)_linux_arm64.tar.gz | tar xz
4444
> ```
4545
>
46-
> **3. Start the Warden server** in dev mode:
46+
> **3. Add the binary to your PATH:**
4747
> ```bash
48-
> ./warden server --dev
48+
> export PATH="$PWD:$PATH"
4949
> ```
5050
>
51-
> **4. In another terminal window**, export the environment variables for the CLI:
51+
> **4. Start the Warden server** in dev mode:
52+
> ```bash
53+
> warden server --dev
54+
> ```
55+
>
56+
> **5. In another terminal window**, export the environment variables for the CLI:
5257
> ```bash
5358
> export WARDEN_ADDR="http://127.0.0.1:8400"
5459
> export WARDEN_TOKEN="<your-token>"

‎provider/github/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,17 @@ The GitHub provider enables proxied access to the GitHub REST API through Warden
4545
> curl -L https://github.com/stephnangue/warden/releases/latest/download/warden_$(curl -s https://api.github.com/repos/stephnangue/warden/releases/latest | grep tag_name | cut -d '"' -f4 | tr -d v)_linux_arm64.tar.gz | tar xz
4646
> ```
4747
>
48-
> **3. Start the Warden server** in dev mode:
48+
> **3. Add the binary to your PATH:**
4949
> ```bash
50-
> ./warden server --dev
50+
> export PATH="$PWD:$PATH"
5151
> ```
5252
>
53-
> **4. In another terminal window**, export the environment variables for the CLI:
53+
> **4. Start the Warden server** in dev mode:
54+
> ```bash
55+
> warden server --dev
56+
> ```
57+
>
58+
> **5. In another terminal window**, export the environment variables for the CLI:
5459
> ```bash
5560
> export WARDEN_ADDR="http://127.0.0.1:8400"
5661
> export WARDEN_TOKEN="<your-token>"

‎provider/gitlab/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,17 @@ The GitLab provider enables proxied access to the GitLab REST API through Warden
4747
> curl -L https://github.com/stephnangue/warden/releases/latest/download/warden_$(curl -s https://api.github.com/repos/stephnangue/warden/releases/latest | grep tag_name | cut -d '"' -f4 | tr -d v)_linux_arm64.tar.gz | tar xz
4848
> ```
4949
>
50-
> **3. Start the Warden server** in dev mode:
50+
> **3. Add the binary to your PATH:**
5151
> ```bash
52-
> ./warden server --dev
52+
> export PATH="$PWD:$PATH"
5353
> ```
5454
>
55-
> **4. In another terminal window**, export the environment variables for the CLI:
55+
> **4. Start the Warden server** in dev mode:
56+
> ```bash
57+
> warden server --dev
58+
> ```
59+
>
60+
> **5. In another terminal window**, export the environment variables for the CLI:
5661
> ```bash
5762
> export WARDEN_ADDR="http://127.0.0.1:8400"
5863
> export WARDEN_TOKEN="<your-token>"

‎provider/mistral/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,17 @@ The Mistral provider enables proxied access to the Mistral AI API through Warden
4343
> curl -L https://github.com/stephnangue/warden/releases/latest/download/warden_$(curl -s https://api.github.com/repos/stephnangue/warden/releases/latest | grep tag_name | cut -d '"' -f4 | tr -d v)_linux_arm64.tar.gz | tar xz
4444
> ```
4545
>
46-
> **3. Start the Warden server** in dev mode:
46+
> **3. Add the binary to your PATH:**
4747
> ```bash
48-
> ./warden server --dev
48+
> export PATH="$PWD:$PATH"
4949
> ```
5050
>
51-
> **4. In another terminal window**, export the environment variables for the CLI:
51+
> **4. Start the Warden server** in dev mode:
52+
> ```bash
53+
> warden server --dev
54+
> ```
55+
>
56+
> **5. In another terminal window**, export the environment variables for the CLI:
5257
> ```bash
5358
> export WARDEN_ADDR="http://127.0.0.1:8400"
5459
> export WARDEN_TOKEN="<your-token>"

‎provider/openai/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,17 @@ The OpenAI provider enables proxied access to the OpenAI API through Warden. It
4343
> curl -L https://github.com/stephnangue/warden/releases/latest/download/warden_$(curl -s https://api.github.com/repos/stephnangue/warden/releases/latest | grep tag_name | cut -d '"' -f4 | tr -d v)_linux_arm64.tar.gz | tar xz
4444
> ```
4545
>
46-
> **3. Start the Warden server** in dev mode:
46+
> **3. Add the binary to your PATH:**
4747
> ```bash
48-
> ./warden server --dev
48+
> export PATH="$PWD:$PATH"
4949
> ```
5050
>
51-
> **4. In another terminal window**, export the environment variables for the CLI:
51+
> **4. Start the Warden server** in dev mode:
52+
> ```bash
53+
> warden server --dev
54+
> ```
55+
>
56+
> **5. In another terminal window**, export the environment variables for the CLI:
5257
> ```bash
5358
> export WARDEN_ADDR="http://127.0.0.1:8400"
5459
> export WARDEN_TOKEN="<your-token>"

‎provider/vault/README.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,17 @@ The Vault provider enables proxied access to HashiCorp Vault (or OpenBao) throug
4848
> curl -L https://github.com/stephnangue/warden/releases/latest/download/warden_$(curl -s https://api.github.com/repos/stephnangue/warden/releases/latest | grep tag_name | cut -d '"' -f4 | tr -d v)_linux_arm64.tar.gz | tar xz
4949
> ```
5050
>
51-
> **3. Start the Warden server** in dev mode:
51+
> **3. Add the binary to your PATH:**
5252
> ```bash
53-
> ./warden server --dev
53+
> export PATH="$PWD:$PATH"
5454
> ```
5555
>
56-
> **4. In another terminal window**, export the environment variables for the CLI:
56+
> **4. Start the Warden server** in dev mode:
57+
> ```bash
58+
> warden server --dev
59+
> ```
60+
>
61+
> **5. In another terminal window**, export the environment variables for the CLI:
5762
> ```bash
5863
> export WARDEN_ADDR="http://127.0.0.1:8400"
5964
> export WARDEN_TOKEN="<your-token>"

0 commit comments

Comments
 (0)