diff --git a/docs/cli/reference/commands.mdx b/docs/cli/commands/commands.mdx similarity index 100% rename from docs/cli/reference/commands.mdx rename to docs/cli/commands/commands.mdx diff --git a/docs/cli/export.mdx b/docs/cli/commands/export.mdx similarity index 83% rename from docs/cli/export.mdx rename to docs/cli/commands/export.mdx index 10a77612e1..fd58868ff8 100644 --- a/docs/cli/export.mdx +++ b/docs/cli/commands/export.mdx @@ -15,7 +15,7 @@ Export environment variables from the platform into a file format. | Option | Description | Default value | | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | `--env` | Used to set the environment that secrets are pulled from. Accepted values: `dev`, `staging`, `test`, `prod` | `dev` | -| `--projectId` | Used to determine from which infisical project your secrets will be exported from (only required if injecting via the service token method). | `None` | +| `--projectId` | Only required if injecting via the [service token method](../token). If you are not using service token, the project id will be automatically retrieved from the `.infisical.json` located at the root of your local project. | `None` | | `--expand` | Parse shell parameter expansions in your secrets (e.g., `${DOMAIN}`) | `true` | | `--format` | Format of the output file. Accepted values: `dotenv`, `csv` and `json` | `dotenv` | diff --git a/docs/cli/reference/init.mdx b/docs/cli/commands/init.mdx similarity index 100% rename from docs/cli/reference/init.mdx rename to docs/cli/commands/init.mdx diff --git a/docs/cli/reference/login.mdx b/docs/cli/commands/login.mdx similarity index 100% rename from docs/cli/reference/login.mdx rename to docs/cli/commands/login.mdx diff --git a/docs/cli/reference/run.mdx b/docs/cli/commands/run.mdx similarity index 100% rename from docs/cli/reference/run.mdx rename to docs/cli/commands/run.mdx diff --git a/docs/cli/overview.mdx b/docs/cli/overview.mdx index 8411b8e758..6267a66f0d 100644 --- a/docs/cli/overview.mdx +++ b/docs/cli/overview.mdx @@ -1,5 +1,5 @@ --- -title: "Overview" +title: "Install" --- Prerequisite: Set up an account with [Infisical Cloud](https://app.infisical.com) or via a [self-hosted installation](/self-hosting/overview). diff --git a/docs/getting-started/dashboard/token.mdx b/docs/getting-started/dashboard/token.mdx index 85f46b7992..9b3ddf79f3 100644 --- a/docs/getting-started/dashboard/token.mdx +++ b/docs/getting-started/dashboard/token.mdx @@ -4,13 +4,16 @@ title: "Infisical Token" An Infisical Token is needed to authenticate the CLI when there isn't an easy way to input your login credentials. -It's useful for the [Docker](/integrations/platforms/docker) and [Docker Compose](/integrations/platforms/docker-compose) integrations. +It's useful for your CI/CD environments and integrations such as [Docker](/integrations/platforms/docker) and [Docker Compose](/integrations/platforms/docker-compose). + +To generate the the token, head over to your project settings as shown below. -It's possible to generate the token in the settings of a project. ![token add](../../images/project-token-add.png) The token grants read-only access to a particular environment and project for - a specified amount of time. + a specified amount of time. Once the token is expired, the CLI using it will no longer be able to make + requests with it. + diff --git a/docs/integrations/platforms/docker-compose.mdx b/docs/integrations/platforms/docker-compose.mdx index 9e0f90e558..f2cdd60c83 100644 --- a/docs/integrations/platforms/docker-compose.mdx +++ b/docs/integrations/platforms/docker-compose.mdx @@ -4,14 +4,14 @@ title: "Docker Compose" The Docker Compose integration enables you to inject environment variables from Infisical into the containers defined in your compose file. -## Add the CLI to your Dockerfile(s) +## Add the CLI to your Dockerfile(s) start command -Follow steps 1 through 3 on our [guide to configure Infisical CLI](../integrations/platforms/docker) in your Dockerfile. +Follow the [guide to configure Infisical CLI](./docker) in your your Dockerfile first. ## Generate Infisical Token In order for Infisical CLI to authenticate and retrieve your project's secrets without exposing your login credentials, you must generate a Infisical Token. -To learn how, visit [Infisical Token](../getting-started/cli/infisical-token). Once you have generated the token, keep it handy. +To learn how, visit [Infisical Token](../../getting-started/dashboard/token). Once you have generated the token, keep it handy. If you have multiple services and they do not use the same secrets, you will diff --git a/docs/mint.json b/docs/mint.json index 1d52466808..4fa0436d8b 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -87,12 +87,12 @@ "cli/overview", "cli/usage", { - "group": "Reference", + "group": "Commands", "pages": [ - "cli/reference/commands", - "cli/reference/login", - "cli/reference/init", - "cli/reference/run" + "cli/commands/login", + "cli/commands/init", + "cli/commands/run", + "cli/commands/export" ] } ]