Skip to content

docs(compute): prefix common environment variables with EIGENX_ #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
solimander merged 1 commit into from
Nov 7, 2025
Merged

docs(compute): prefix common environment variables with EIGENX_ #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/products/eigencompute/howto/manage-auth-keys/manage-authentication-keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ When using EigenX, logging in refers to providing your authentication key to the
are supported and checked in this order:

1. `--private-key` flag on any command (not recommended).
2. `PRIVATE_KEY` environment variable.
2. `EIGENX_PRIVATE_KEY` environment variable.
3. OS keyring securely stored credentials.

:::warning
Using the `--private-key` flag to provide your private key directly on the command line is not recommended. When provided on the command line
it may be stored in your shell history. Use the OS keyring to securely store credentials or the `PRIVATE_KEY` environment
it may be stored in your shell history. Use the OS keyring to securely store credentials or the `EIGENX_PRIVATE_KEY` environment
variable for CI/CD pipelines.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/products/eigencompute/reference/cli-commands/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ eigenx auth logout [--env <environment>] [--all]
Instead of storing your private key in the keyring, you can provide it via environment variable:

```bash
export PRIVATE_KEY=0x1234567890abcdef...
export EIGENX_PRIVATE_KEY=0x1234567890abcdef...
eigenx app deploy
```

Expand Down
2 changes: 1 addition & 1 deletion docs/products/eigencompute/reference/cli-commands/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ eigenx app deploy --dockerfile ./Dockerfile --env-file ./.env

```bash
# In CI/CD script
export PRIVATE_KEY=$CI_PRIVATE_KEY
export EIGENX_PRIVATE_KEY=$CI_PRIVATE_KEY
docker build --platform linux/amd64 -t registry.io/app:$CI_COMMIT_SHA .
docker push registry.io/app:$CI_COMMIT_SHA
eigenx app deploy registry.io/app:$CI_COMMIT_SHA
Expand Down
6 changes: 3 additions & 3 deletions static/eigenx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8564,13 +8564,13 @@ var (
RpcUrlFlag = &cli.StringFlag{
Name: "rpc-url",
Usage: "RPC URL to connect to blockchain",
EnvVars: []string{"RPC_URL"},
EnvVars: []string{"EIGENX_RPC_URL"},
}

PrivateKeyFlag = &cli.StringFlag{
Name: "private-key",
Usage: "Private key for signing transactions",
EnvVars: []string{"PRIVATE_KEY"},
EnvVars: []string{"EIGENX_PRIVATE_KEY"},
}

ForceFlag = &cli.BoolFlag{
Expand Down Expand Up @@ -11333,7 +11333,7 @@ eigenx auth logout # Remove key
### 2. Environment Variable

```bash
export PRIVATE_KEY=0x1234...
export EIGENX_PRIVATE_KEY=0x1234...
eigenx app deploy
```

Expand Down