Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.
TypeScript acmeagentsai-agentscertificate-managementdevsecopsenvironment-variableskubernetesopen-sourcepampkipostgresprivate-caprivileged-access-managementsecret-managementsecret-managersecretssecrets-managementsecuritysecurity-toolsvault
update docs for yaml migration
adilsone08115fea24a
diff --git a/docs/cli/project-config-migration.mdx b/docs/cli/project-config-migration.mdxdeleted file mode 100644index 93048ebc46..0000000000--- a/docs/cli/project-config-migration.mdx+++ /dev/null@@ -1,180 +0,0 @@-----title: "Migrate to .infisical.yaml"-description: "The Infisical CLI now reads project settings from `.infisical.yaml` instead of `.infisical.json`, and creates `.infisical.yaml` from an existing `.infisical.json`."------## What changed--The CLI is moving away from `.infisical.json`. It now reads [project settings](/cli/project-config) from `.infisical.yaml`. The CLI still reads `.infisical.json` for now, but a future release will stop reading it.--Starting with version 0.44.3, if you run a command in a directory that has `.infisical.json`, the CLI creates `.infisical.yaml` in the same directory with the same settings. The CLI leaves `.infisical.json` in place for you to delete.--## Who is affected--You're affected if you use an `.infisical.json` file anywhere, including:--- Repositories with a committed `.infisical.json`-- Container images that copy `.infisical.json` into the image--## Prerequisites--- Infisical CLI 0.43.145 or later on every machine that reads the file, including developer machines, CI pipelines, and container images ([upgrade the CLI](/cli/upgrade))--Older versions of the CLI don't read `.infisical.yaml`, so after you delete `.infisical.json`, those versions can't find the project linked to the directory.--## Migration steps--Let the CLI create `.infisical.yaml` from `.infisical.json`, or create `.infisical.yaml` by hand.--<Tabs>- <Tab title="Let the CLI create the file">- <Note>- The CLI creates `.infisical.yaml` for you in version 0.44.3 and later. If your CLI is older, [upgrade it](/cli/upgrade) or create `.infisical.yaml` by hand.- </Note>-- <Steps>- <Step>- In the directory that holds `.infisical.json`, run any `infisical` command, such as:-- ```bash- infisical sm secrets- ```-- The CLI creates `.infisical.yaml` and prints the path of the new file, followed by a warning that both files exist:-- ```- Created /home/user/my-app/.infisical.yaml from the legacy /home/user/my-app/.infisical.json (commit it if this project is under version control).- Warning: Both .infisical.yaml and .infisical.json exist in /home/user/my-app. .infisical.yaml takes precedence, so the legacy /home/user/my-app/.infisical.json is no longer used and you can remove it.- ```- </Step>- <Step>- Delete `.infisical.json`, then commit the new file and the deletion:-- ```bash- rm .infisical.json- git add .infisical.yaml .infisical.json- git commit -m "Migrate Infisical CLI config to .infisical.yaml"- ```- </Step>- </Steps>-- If your repository has more than one `.infisical.json`, such as one per package in a monorepo, run a command in each directory that holds one.-- </Tab>- <Tab title="Edit the file by hand">- <Steps>- <Step>- In the directory that holds `.infisical.json`, create a file named `.infisical.yaml`. The CLI doesn't read a file named `.infisical.yml`.- </Step>- <Step>- Copy each field from `.infisical.json` to its key in `.infisical.yaml`:-- | `.infisical.json` field | `.infisical.yaml` key |- | --- | --- |- | `workspaceId` | `secrets-management.project-id` |- | `defaultEnvironment` | `secrets-management.default-environment` |- | `gitBranchToEnvironmentMapping` | `secrets-management.mappings.git-branch-to-environment` |- | `defaultSecretPath` | `secrets-management.default-secret-path` |- | `domain` | `general.domain` |-- <Note>- `workspaceId` is the old name for the project ID, so copy its value into `project-id` as is.- </Note>--- For example, this `.infisical.json`:-- ```json .infisical.json- {- "workspaceId": "<project-id>",- "defaultEnvironment": "dev",- "gitBranchToEnvironmentMapping": {- "main": "prod",- "staging": "staging"- },- "defaultSecretPath": "/backend",- "domain": "https://eu.infisical.com"- }- ```-- becomes this `.infisical.yaml`:-- ```yaml .infisical.yaml- general:- domain: https://eu.infisical.com- secrets-management:- project-id: <project-id>- default-environment: dev- default-secret-path: /backend- mappings:- git-branch-to-environment:- main: prod- staging: staging- ```-- The CLI ignores keys it doesn't recognize, so if you misspell a key, the CLI drops that setting without reporting an error.- </Step>- <Step>- Delete `.infisical.json`, then commit both changes.- </Step>- </Steps>-- </Tab>-</Tabs>--If a Dockerfile or CI script refers to `.infisical.json` by name, such as in a `COPY` instruction, change it to `.infisical.yaml`.--## Verify the migration--In the directory that holds `.infisical.yaml`, run a command that reads the file, such as:--```bash-infisical sm secrets-```--Check that the command lists the secrets from the project and environment you expect. If it reports that the project ID is missing, compare the keys in `.infisical.yaml` with the [field mapping](#migration-steps).--## FAQ--<AccordionGroup>- <Accordion title="What if .infisical.json and .infisical.yaml are in the same directory?">- The CLI reads `.infisical.yaml` and ignores `.infisical.json`, so changes- you make to `.infisical.json` don't apply. Make any changes in- `.infisical.yaml`.-- In version 0.44.3 and later, each time you run a command, the CLI also- prints a warning that both files exist. To stop the warning, delete- `.infisical.json`.-- </Accordion>- <Accordion title="Can I run infisical init instead?">- `infisical init` writes a new `.infisical.yaml` that holds only the project- ID, so you lose the environment, branch mapping, folder, and instance- settings from `.infisical.json`. To keep those settings, let the CLI create- `.infisical.yaml` from `.infisical.json`, or create `.infisical.yaml` by- hand.-- </Accordion>- <Accordion title="What if the CLI can't create .infisical.yaml?">- If the CLI can't write `.infisical.yaml` the command still runs with the settings in- `.infisical.json`, and the CLI tries again the next time you run a command.- At most once a day, the CLI also prints a deprecation notice that names the- directory it couldn't write to.-- To finish the migration, make the directory writable and run a command- again, or follow the steps in the **Edit the file by hand** tab.-- </Accordion>- <Accordion title="How do I hide the deprecation notice?">- The notice stops once `.infisical.yaml` exists. To hide the notice before- then, set the `INFISICAL_DISABLE_WORKSPACE_CONFIG_MIGRATION_NOTICE`- environment variable to any value, such as `true`. Neither the variable nor- `--silent` hides the warning that both files exist. To stop that warning,- delete `.infisical.json`.-- The CLI writes the notice, the warning, and the message about creating- `.infisical.yaml` to standard error, so they don't change the output of- commands like `infisical export`.-- </Accordion>-</AccordionGroup>diff --git a/docs/cli/project-config.mdx b/docs/cli/project-config.mdxindex 4ab7fbe1e6..7101cf8f32 100644--- a/docs/cli/project-config.mdx+++ b/docs/cli/project-config.mdx@@ -3,16 +3,19 @@ title: "Project configuration"description: "Configure how the Infisical CLI interacts with your directory."----<Warning>- `.infisical.yaml` replaces `.infisical.json`, which is deprecated. The CLI still reads `.infisical.json`. Starting with version 0.44.3, the CLI also creates `.infisical.yaml` with the same settings the first time a command reads `.infisical.json`. To finish moving to the new format, see [Migrate to .infisical.yaml](/cli/project-config-migration).-</Warning>--`.infisical.yaml` links a directory to an [Infisical project](/documentation/platform/project). When you run a command such as [`infisical sm run`](/cli/reference#sm-run) or [`infisical sm secrets`](/cli/reference#sm-secrets) in that directory, the CLI reads the project from the file, so you don't have to pass [`--projectId`](/cli/reference#sm-run--flag-projectid).+A project config file links a directory to an [Infisical project](/documentation/platform/project). When you run a command such as [`infisical sm run`](/cli/reference#sm-run) or [`infisical sm secrets`](/cli/reference#sm-secrets) in that directory, the CLI reads the project from the file, so you don't have to pass [`--projectId`](/cli/reference#sm-run--flag-projectid).The file can also [choose an environment](#set-the-environment) and [a folder](#set-the-folder) for you, and [pin the Infisical instance](#set-the-infisical-instance) the project lives on.+The CLI reads the settings from either of two files:++- `.infisical.yaml`, which [`infisical init`](/cli/reference#init) creates+- `.infisical.json`, which older versions of `infisical init` created++Both files hold the same settings, so you don't need to convert an existing `.infisical.json`. Each example on this page shows both formats.+<Info>-The `.infisical.yaml` file doesn't include any sensitive values and is safe to commit to version control.+Neither file includes any sensitive values, so both are safe to commit to version control.</Info>## Create the file@@ -26,82 +29,146 @@ infisical initSelect the project when prompted. The CLI writes `.infisical.yaml` to the current directory:```yaml .infisical.yaml+version: 1general: {}secrets-management:- project-id: <project-id>- default-environment: ""- mappings:- git-branch-to-environment: {}+ project-id: <project-id>```-`project-id` is the project's ID. The other settings are empty until you set them, as described in the sections that follow. If you run [`infisical init`](/cli/reference#init) again, the CLI replaces the file with a new one that holds only the project ID, so you lose any settings you added.+`project-id` is the project's ID, and `version` is the version of the file format. To add more settings, edit the file as described in the sections that follow.++<Note>+ If you authenticate as a [machine identity](/documentation/platform/identities/machine-identities), `infisical sm run`, [`infisical sm export`](/cli/reference#sm-export), and `infisical sm secrets` don't read the project from the file. Pass the project with `--projectId` or the `INFISICAL_PROJECT_ID` environment variable instead.+</Note>++If the directory already has `.infisical.yaml` or `.infisical.json`, `infisical init` asks before it writes a new `.infisical.yaml`. The new file holds only the project ID, and the CLI reads it instead of the old file, so you lose the settings in the old file. To keep those settings, edit the old file instead of running `infisical init`.<Note>- If you authenticate as a [machine identity](/documentation/platform/identities/machine-identities), `infisical sm run`, [`infisical sm export`](/cli/reference#sm-export), and `infisical sm secrets` don't read `project-id`. Pass the project with `--projectId` or the `INFISICAL_PROJECT_ID` environment variable instead.+ CLI versions earlier than 0.43.145 read only `.infisical.json`. If a developer machine, CI pipeline, or container image runs an older version, [upgrade the CLI](/cli/upgrade) there before you commit `.infisical.yaml`.</Note>## Set the environment-Without an environment setting, commands read secrets from your project's [`dev` environment](/documentation/platform/secrets-mgmt/project#project-environments) unless you pass [`--env`](/cli/reference#sm-run--flag-env). To use a different environment by default, set `default-environment` to the environment's slug:+Without an environment setting, commands read secrets from your project's [`dev` environment](/documentation/platform/secrets-mgmt/project#project-environments) unless you pass [`--env`](/cli/reference#sm-run--flag-env). To use a different environment by default, set `environment.default` under `secrets-management` to the environment's slug (`defaultEnvironment` in `.infisical.json`):++<CodeGroup>```yaml .infisical.yaml+version: 1secrets-management:project-id: <project-id>- default-environment: staging+ environment:+ default: staging```-To pick the environment from the Git branch you're on, map branch names to environment slugs under `mappings.git-branch-to-environment`:+```json .infisical.json+{+ "workspaceId": "<project-id>",+ "defaultEnvironment": "staging"+}+```++</CodeGroup>++To pick the environment from the Git branch you're on, list each branch and its environment slug under `environment.overrides.git-branch` (`gitBranchToEnvironmentMapping` in `.infisical.json`):++<CodeGroup>```yaml .infisical.yaml+version: 1secrets-management:project-id: <project-id>- default-environment: dev- mappings:- git-branch-to-environment:- main: prod- staging: staging+ environment:+ default: dev+ overrides:+ git-branch:+ - branch: main+ environment: prod+ - branch: staging+ environment: staging+```++```json .infisical.json+{+ "workspaceId": "<project-id>",+ "defaultEnvironment": "dev",+ "gitBranchToEnvironmentMapping": {+ "main": "prod",+ "staging": "staging"+ }+}```-The CLI matches only the last part of a branch name, after the final `/`. For example, the branch `release/staging` matches the key `staging`. If your current branch has no mapping, or you aren't on a branch (such as when you check out a specific commit), the CLI falls back to `default-environment`.+</CodeGroup>++The CLI matches only the last part of a branch name, after the final `/`. For example, the branch `release/staging` matches `staging`. If your current branch has no match, or you aren't on a branch (such as when you check out a specific commit), the CLI falls back to the default environment.++<Note>+ If an older version of `infisical init` wrote your `.infisical.yaml`, the file may set `default-environment` and `mappings.git-branch-to-environment` instead. The CLI still reads both keys. If `environment.default` is set, the CLI ignores `default-environment`. If `environment.overrides.git-branch` has any entries, the CLI ignores `mappings.git-branch-to-environment`.+</Note>The CLI picks the environment in this order:1. The `--env` flag2. The `INFISICAL_ENVIRONMENT` environment variable-3. The environment mapped to your current Git branch-4. `default-environment`+3. The environment that matches your current Git branch+4. The default environment (`environment.default` or `defaultEnvironment`)5. `dev`## Set the folder-Without a folder setting, commands read secrets from the root of the environment (`/`) unless you pass [`--path`](/cli/reference#sm-run--flag-path). To read from a different [folder](/documentation/platform/folder) by default, set `default-secret-path` under `secrets-management`:+Without a folder setting, commands read secrets from the root of the environment (`/`) unless you pass [`--path`](/cli/reference#sm-run--flag-path). To read from a different [folder](/documentation/platform/folder) by default, set `default-secret-path` under `secrets-management` (`defaultSecretPath` in `.infisical.json`):++<CodeGroup>```yaml .infisical.yaml+version: 1secrets-management:project-id: <project-id>default-secret-path: /backend```+```json .infisical.json+{+ "workspaceId": "<project-id>",+ "defaultSecretPath": "/backend"+}+```++</CodeGroup>+The CLI picks the folder in this order:1. The `--path` flag2. The `INFISICAL_SECRET_PATH` environment variable-3. `default-secret-path`+3. `default-secret-path` or `defaultSecretPath`4. `/`The [`infisical sm secrets folders`](/cli/reference#sm-secrets-folders) commands don't read either setting, so pass `--path` to work in a folder other than `/`.## Set the Infisical instance-If your project is on EU Cloud, a dedicated instance, or a self-hosted instance, set `domain` under `general` to the instance's address:+If your project is on EU Cloud, a dedicated instance, or a self-hosted instance, set `domain` under `general` to the instance's address (`domain` in `.infisical.json`):++<CodeGroup>```yaml .infisical.yaml+version: 1general:domain: https://eu.infisical.comsecrets-management:project-id: <project-id>```+```json .infisical.json+{+ "workspaceId": "<project-id>",+ "domain": "https://eu.infisical.com"+}+```++</CodeGroup>+`domain` must be a URL that starts with `https://` or `http://`, or the CLI ignores it and prints a warning.<Note>@@ -112,7 +179,7 @@ The CLI picks the instance in this order:1. The [`--domain`](/cli/reference#global-flags--flag-domain) flag2. The `INFISICAL_DOMAIN` environment variable, or the older `INFISICAL_API_URL` if `INFISICAL_DOMAIN` isn't set-3. `domain` in `.infisical.yaml`+3. `general.domain` in `.infisical.yaml`, or `domain` in `.infisical.json`4. US Cloud (`https://app.infisical.com`)If you log in with your own account, [`infisical login`](/cli/reference#login) uses `domain` to choose the instance to log in to. After that:@@ -121,12 +188,20 @@ If you log in with your own account, [`infisical login`](/cli/reference#login) u- If you pass `--domain` or set `INFISICAL_DOMAIN` to a different instance than the one you logged in to, the command fails<Warning>- The CLI sends every request and credential to the instance in `domain`. Because `.infisical.yaml` is usually committed, anyone who can change the file in your repository can change where the CLI sends them. Each time the CLI uses `domain` from the file, it prints a warning that names the host. Only set `domain` to an instance you trust, and check it when you clone a repository you don't control.+ The CLI sends every request and credential to the instance in `domain`. Because the project config file is usually committed, anyone who can change the file in your repository can change where the CLI sends them. Each time the CLI uses `domain` from the file, it prints a warning that names the host. Only set `domain` to an instance you trust, and check it when you clone a repository you don't control.</Warning>-## Use the file from another directory+## Where the CLI looks for the file++The CLI looks for a project config file in the current directory, then in each parent directory up to the root of the file system. If you have a project config file in the root of your codebase, that file applies to every directory under it.++In each directory, the CLI checks for `.infisical.yaml` first, then `.infisical.json`, and uses the first file it finds:-The CLI looks for `.infisical.yaml` in the current directory, then in each parent directory up to the root of the file system. This means that if you have an `.infisical.yaml` file in the root of your codebase, that configuration applies to every directory under it.+- If a directory has both files, the CLI reads `.infisical.yaml` and ignores `.infisical.json`+- If the current directory has `.infisical.json` and a parent directory has `.infisical.yaml`, the CLI reads `.infisical.json`+- The CLI doesn't read a file named `.infisical.yml`++## Use the file from another directoryTo read the project from a file somewhere else, such as one package's directory in a monorepo, pass the directory to `infisical sm run` with [`--project-config-dir`](/cli/reference#sm-run--flag-project-config-dir):@@ -134,28 +209,36 @@ To read the project from a file somewhere else, such as one package's directoryinfisical sm run --project-config-dir ./services/api -- npm run dev```+The CLI checks only that directory, not its parent directories.+<Note>-`--project-config-dir` sets the project, environment, and folder. The instance setting still comes from the `.infisical.yaml` the CLI finds from your current directory.+`--project-config-dir` sets the project, environment, and folder. The instance setting still comes from the project config file the CLI finds from your current directory.</Note>## Field reference+The CLI ignores keys it doesn't recognize, so if you misspell a key, the CLI drops that setting without reporting an error.++<ResponseField name="version" type="number">+The version of the `.infisical.yaml` format. `infisical init` sets it to `1`. `.infisical.json` has no version field.+</ResponseField>+<ResponseField name="secrets-management.project-id" type="string">-The ID of the project to read secrets from. Not used when you authenticate as a machine identity.+The ID of the project to read secrets from. Not used when you authenticate as a machine identity. In `.infisical.json`, the field is `workspaceId`.</ResponseField>-<ResponseField name="secrets-management.default-environment" type="string">-The environment slug to use when `--env` and `INFISICAL_ENVIRONMENT` aren't set and no branch mapping matches.+<ResponseField name="secrets-management.environment.default" type="string">+The environment slug to use when `--env` and `INFISICAL_ENVIRONMENT` aren't set and no branch override matches. In `.infisical.json`, the field is `defaultEnvironment`.</ResponseField>-<ResponseField name="secrets-management.mappings.git-branch-to-environment" type="object">-Maps branch names to environment slugs, such as `main: prod`. Keys match only the last part of a branch name, after the final `/`.+<ResponseField name="secrets-management.environment.overrides.git-branch" type="object[]">+A list of branches, each with the environment slug to use on that branch, such as `branch: main` and `environment: prod`. The CLI compares each `branch` with only the last part of the current branch name, after the final `/`. In `.infisical.json`, the field is `gitBranchToEnvironmentMapping`, an object that maps branch names to environment slugs, such as `"main": "prod"`.</ResponseField><ResponseField name="secrets-management.default-secret-path" type="string">-The folder to read secrets from when [`--path`](/cli/reference#sm-run--flag-path) and `INFISICAL_SECRET_PATH` aren't set. The `infisical sm` commands read it, except `infisical sm secrets folders`.+The folder to read secrets from when [`--path`](/cli/reference#sm-run--flag-path) and `INFISICAL_SECRET_PATH` aren't set. The `infisical sm` commands read it, except `infisical sm secrets folders`. In `.infisical.json`, the field is `defaultSecretPath`.</ResponseField><ResponseField name="general.domain" type="string">-The Infisical instance to connect to, such as `https://eu.infisical.com`. Must start with `https://` or `http://`.+The Infisical instance to connect to, such as `https://eu.infisical.com`. Must start with `https://` or `http://`. In `.infisical.json`, the field is `domain`.</ResponseField>diff --git a/docs/cli/reference.mdx b/docs/cli/reference.mdxindex 32c8d99529..b0b1e3b913 100644--- a/docs/cli/reference.mdx+++ b/docs/cli/reference.mdx@@ -333,10 +333,10 @@ Stop and remove a gateway's systemd service. Run the command as root on Linux.Link the current directory to an Infisical project. The command lists the projects in your profile's organization and writes the one you choose to `.infisical.yaml`, so later commands in this directory and its subdirectories know which project to use. It needs a user login, and starts one if you have no profile.-If the current directory already has an `.infisical.yaml` or a legacy `.infisical.json`, the command asks before writing a new `.infisical.yaml`. The new file holds only the project ID, so settings you added, such as `default-environment`, no longer apply. To keep the settings in a legacy `.infisical.json`, [convert it](/cli/project-config-migration) instead of running `init`. See [project config](/cli/project-config) for the file format.+If the current directory already has an `.infisical.yaml` or a legacy `.infisical.json`, the command asks before writing a new `.infisical.yaml`. The new file holds only the project ID, and the CLI reads it instead of the old file, so settings you added, such as the default environment, no longer apply. To keep those settings, edit the existing file instead of running `init`. See [project config](/cli/project-config) for the file format.<Note>- If you run `init` without a terminal, such as in CI or from a script, the command never prompts. It exits with an error unless you pass `--project-id`, and it doesn't replace an existing `.infisical.yaml` or legacy `.infisical.json`. To link a different project, edit `secrets-management.project-id` in `.infisical.yaml`.+ If you run `init` without a terminal, such as in CI or from a script, the command never prompts. It exits with an error unless you pass `--project-id`, and it doesn't replace an existing `.infisical.yaml` or legacy `.infisical.json`. To link a different project, edit `secrets-management.project-id` in `.infisical.yaml`, or `workspaceId` in a legacy `.infisical.json`.</Note></CLICommand>@@ -1180,7 +1180,7 @@ For an agent on your own computer, [infisical sm agent-proxy run](/cli/reference{ name: "--allow-readable-brokered-secrets", type: "bool", description: "Start the agent even if it can read the real value of a secret that a proxied service substitutes into its requests. Without this flag, the command exits with an error, and you fix it by removing the agent's read permission on that secret. Can also be set with `INFISICAL_AGENT_PROXY_ALLOW_READABLE_BROKERED_SECRETS`." },{ name: "--client-id", value: "<string>", type: "string", description: "The client ID of the agent's machine identity. Can also be set with `INFISICAL_UNIVERSAL_AUTH_CLIENT_ID`." },{ name: "--client-secret", value: "<string>", type: "string", description: "The client secret of the agent's machine identity. Can also be set with `INFISICAL_UNIVERSAL_AUTH_CLIENT_SECRET`." },- { name: "--env", short: "-e", value: "<string>", type: "string", required: true, description: "The environment to fetch proxied services and secrets from. Without it, the CLI reads `INFISICAL_ENVIRONMENT`, then the environment that `.infisical.yaml` maps to your git branch, then its `default-environment`." },+ { name: "--env", short: "-e", value: "<string>", type: "string", required: true, description: "The environment to fetch proxied services and secrets from. Without it, the CLI reads `INFISICAL_ENVIRONMENT`, then the environment that `.infisical.yaml` maps to your git branch, then its `environment.default`." },{ name: "--no-proxy", value: "<string>", type: "string", description: "More hosts for the agent to reach directly instead of through the proxy, separated by commas. Always merged with `localhost,127.0.0.1` and any `NO_PROXY` in your environment." },{ name: "--path", value: "<string>", type: "string", default: "/", description: "The folder to fetch proxied services and secrets from. Without it, the CLI reads `INFISICAL_SECRET_PATH`, then `default-secret-path` in `.infisical.yaml`." },{ name: "--projectId", value: "<string>", type: "string", required: true, description: "The project to fetch proxied services and secrets from. Can also be set with `INFISICAL_PROJECT_ID`, or read from `.infisical.yaml`." },@@ -1215,7 +1215,7 @@ The command exits with the agent's exit code.{ name: "--allow-host", value: "<stringArray>", type: "stringArray", description: "A host the agent can reach, without a credential, when `--unmatched-host=block` is set. Repeatable." },{ name: "--allow-read", value: "<stringArray>", type: "stringArray", description: "A path the agent can read even though the sandbox blocks it by default, such as `~/.aws/config`. The path stays read-only, and the rest of a denied directory stays denied. Repeatable." },{ name: "--allow-write", value: "<stringArray>", type: "stringArray", description: "A path the agent can write, beyond the working directory, the temporary directory, and the state directories of Claude Code, Codex, and Gemini CLI. Repeatable." },- { name: "--env", short: "-e", value: "<string>", type: "string", required: true, description: "The environment to fetch proxied services from. Without it, the CLI reads `INFISICAL_ENVIRONMENT`, then the environment that `.infisical.yaml` maps to your git branch, then its `default-environment`." },+ { name: "--env", short: "-e", value: "<string>", type: "string", required: true, description: "The environment to fetch proxied services from. Without it, the CLI reads `INFISICAL_ENVIRONMENT`, then the environment that `.infisical.yaml` maps to your git branch, then its `environment.default`." },{ name: "--log-file", value: "<string>", type: "string", description: "A file to write the proxy's per-request activity to. The file is appended to. Without it, nothing is written, and only warnings and errors print to stderr unless you pass `--log-level`." },{ name: "--no-sandbox", type: "bool", description: "Run the agent without the OS sandbox. Credentials are still brokered, but the agent can read your files and keyring and reach the network directly." },{ name: "--pass-env", value: "<stringArray>", type: "stringArray", description: "One of your environment variables to pass through to the agent, by name, when the command would otherwise remove it. Repeatable." },diff --git a/docs/docs.json b/docs/docs.jsonindex 3a2b1fe4a9..ed1837117e 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -1300,7 +1300,6 @@"pages": ["cli/overview","cli/cloudsmith-migration",- "cli/project-config-migration",{"group": "Get started","pages": [@@ -4972,6 +4971,10 @@"source": "/cli/commands/init","destination": "/cli/reference#init"},+ {+ "source": "/cli/project-config-migration",+ "destination": "/cli/project-config"+ },{"source": "/cli/commands/kmip","destination": "/cli/reference#kmip"diff --git a/docs/documentation/platform/agent-proxy/local-agent-proxy.mdx b/docs/documentation/platform/agent-proxy/local-agent-proxy.mdxindex 8947f63aa4..cc1e5bd4bc 100644--- a/docs/documentation/platform/agent-proxy/local-agent-proxy.mdx+++ b/docs/documentation/platform/agent-proxy/local-agent-proxy.mdx@@ -102,7 +102,7 @@ Every option resolves the same way: **the flag → an environment variable → `| Option | Flag | Environment variable | `.infisical.yaml` || --- | --- | --- | --- || Project | `--projectId` | `INFISICAL_PROJECT_ID` | `secrets-management.project-id` |-| Environment slug | `--env` | `INFISICAL_ENVIRONMENT` | `secrets-management.default-environment` |+| Environment slug | `--env` | `INFISICAL_ENVIRONMENT` | `secrets-management.environment.default` || Secret path | `--path` | `INFISICAL_SECRET_PATH` | `secrets-management.default-secret-path` || Instance | `--domain` | `INFISICAL_DOMAIN` | `general.domain` || Sandbox | `--sandbox` / `--no-sandbox` | `INFISICAL_AGENT_PROXY_SANDBOX` | — |diff --git a/docs/documentation/platform/agent-proxy/standalone-agent-proxy.mdx b/docs/documentation/platform/agent-proxy/standalone-agent-proxy.mdxindex 4189349e43..aa75f56b9d 100644--- a/docs/documentation/platform/agent-proxy/standalone-agent-proxy.mdx+++ b/docs/documentation/platform/agent-proxy/standalone-agent-proxy.mdx@@ -69,7 +69,7 @@ Every option resolves from the same sources, in order: **the flag → an environ| Auth | `--client-id` / `--client-secret` | `INFISICAL_UNIVERSAL_AUTH_CLIENT_ID` / `_SECRET` | — || Instance | `--domain` | `INFISICAL_DOMAIN` | `general.domain` || Project | `--projectId` | `INFISICAL_PROJECT_ID` | `secrets-management.project-id` |-| Environment slug | `--env` | `INFISICAL_ENVIRONMENT` | `secrets-management.default-environment` |+| Environment slug | `--env` | `INFISICAL_ENVIRONMENT` | `secrets-management.environment.default` || Secret path | `--path` | `INFISICAL_SECRET_PATH` | `secrets-management.default-secret-path` || Proxy address | `--proxy` | `INFISICAL_AGENT_PROXY_ADDRESS` | — |