Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

docs(cli): satisfy the docs style rules and scope profiles to user login

Scott Wilsonbd662cdacd99
diff --git a/docs/.vale/styles/config/vocabularies/Infisical/any-case/accept.txt b/docs/.vale/styles/config/vocabularies/Infisical/any-case/accept.txt
index ad27772182..ca6530be03 100644
--- a/docs/.vale/styles/config/vocabularies/Infisical/any-case/accept.txt
+++ b/docs/.vale/styles/config/vocabularies/Infisical/any-case/accept.txt
@@ -45,7 +45,7 @@
(?i)scan
(?i)flags
(?i)sub commands
-(?i)infisical (?:agent|agent-proxy|agent-vault|av|bootstrap|dynamic-secrets|export|gateway|init|kmip|login|pam|relay|reset|run|scan|secrets|service-token|token|user|vault)
+(?i)infisical (?:agent|agent-proxy|agent-vault|av|bootstrap|dynamic-secrets|export|gateway|init|kmip|login|logout|org|pam|profile|relay|reset|run|scan|secrets|service-token|token|user|vault)
# Acronyms that collide with ordinary English words, shell commands, or
# Kubernetes units.
diff --git a/docs/cli/commands/init.mdx b/docs/cli/commands/init.mdx
index 3c76d11a23..d9a45bc9fd 100644
--- a/docs/cli/commands/init.mdx
+++ b/docs/cli/commands/init.mdx
@@ -18,8 +18,8 @@ Link a local project to your Infisical project. Once connected, you can then acc
The command lists the projects of the organization that your profile uses. To link a project in another organization, change the default with `infisical profile set-org`. You can also create a profile for that organization with `infisical profile new`. See [profile](./profile).
<Warning>
- Do not pass `--org` to link a project from another organization. Later
- commands use the organization of the profile and cannot find that project.
+ Don't pass `--org` to link a project from another organization. Later
+ commands use the organization of the profile and can't find that project.
The command stops and names the two options above.
</Warning>
diff --git a/docs/cli/commands/login.mdx b/docs/cli/commands/login.mdx
index efc4534dcd..0e6a83d88d 100644
--- a/docs/cli/commands/login.mdx
+++ b/docs/cli/commands/login.mdx
@@ -19,7 +19,9 @@ When authenticated, a token is generated and saved in your system Keyring to all
To change where the login credentials are stored, visit the [vaults command](./vault).
-Each login is stored as a profile: an account on the specified Infisical instance, with the organization that it uses by default. A login without flags becomes the default profile for this machine. To store a login under a name you choose, and leave the default alone, pass `--save-as`. See [profile](./profile) for how to select from existing profiles.
+A user login is stored as a profile: an account on the specified Infisical instance, with the organization that it uses by default. A user login without flags becomes the default profile for this machine. To store one under a name you choose, and leave the default alone, pass `--save-as`. See [profile](./profile) for how to select from existing profiles.
+
+Machine identity logins don't create a profile. They print an access token, which you supply through `INFISICAL_TOKEN` or `--token`.
<Info>
**JWT Token Output:**
@@ -69,7 +71,7 @@ User authentication is designed for individual developers and supports multiple
</ParamField>
<ParamField query="save-as" type="string" optional>
Store this login as the named profile, creating a new profile or replacing
- an existing one's session. The new profile is not automatically selected.
+ an existing one's session. The new profile isn't automatically selected.
</ParamField>
<ParamField query="profile" type="string" optional>
Sign back in to a profile that already exists, restoring its account,
diff --git a/docs/cli/commands/logout.mdx b/docs/cli/commands/logout.mdx
index d663d42647..9b1f0471bd 100644
--- a/docs/cli/commands/logout.mdx
+++ b/docs/cli/commands/logout.mdx
@@ -9,7 +9,7 @@ infisical logout
## Description
-This command ends a login session. The CLI removes the stored credentials of the profile from this machine, and revokes its session on the server.
+This command ends a login session. The CLI removes the stored credentials of the profile from this machine, and revokes its session on the server when no other profile still uses that session.
The profile is kept, so `infisical login --profile <name>` signs back in without setting it up again. To remove the profile as well, run `infisical profile delete`.
diff --git a/docs/cli/commands/org.mdx b/docs/cli/commands/org.mdx
index 10d249bd62..584c6fd396 100644
--- a/docs/cli/commands/org.mdx
+++ b/docs/cli/commands/org.mdx
@@ -51,13 +51,13 @@ If you omit the organization, the CLI will ask you to pick one.
### Choosing an organization for one command
-Pass `--org` to retarget a single command. Name the organization by name, slug, or id.
+Pass `--org` to point a single command at another organization. Name the organization by name, slug, or id.
```bash
infisical --org globex-inc secrets
```
-The default organization of the profile does not change. The CLI caches the session for each organization that you use this way.
+The default organization of the profile doesn't change. The CLI caches the session for each organization that you use this way.
<Tip>
The `org` flag can be substituted with the `INFISICAL_ORG` environment
diff --git a/docs/cli/commands/profile.mdx b/docs/cli/commands/profile.mdx
index 2659770b4e..afde9bc736 100644
--- a/docs/cli/commands/profile.mdx
+++ b/docs/cli/commands/profile.mdx
@@ -79,7 +79,7 @@ Domain: https://app.infisical.com
</Accordion>
<Accordion title="infisical profile new">
- Create a profile for another organization without logging in again. The new profile reuses the account and instance that you are signed in to.
+ Create a profile for another organization without logging in again. The new profile reuses the account and instance that you're signed in to.
```bash
infisical profile new [name]
@@ -104,7 +104,7 @@ infisical profile new globex --org globex-inc
<Accordion title="--pin">
Also pin this terminal to the new profile. Run the command through `eval`,
- because a command cannot change the environment of the shell that started it.
+ because a command can't change the environment of the shell that started it.
```bash
eval "$(infisical profile new globex --org globex-inc --pin)"
@@ -131,7 +131,7 @@ infisical profile use globex
<Accordion title="infisical profile pin">
Pin the current terminal to a profile. Other terminals keep the profile that they already use.
-The command prints an export statement. Run it through `eval` to apply it to the shell that you are in.
+The command prints an export statement. Run it through `eval` to apply it to the shell that you're in.
```bash
eval "$(infisical profile pin globex)"
@@ -166,7 +166,7 @@ If you omit the path, the CLI binds the current directory. If bindings overlap,
<Info>
The binding is stored in your own configuration, never in the repository, so
- it does not affect anyone else who clones the project.
+ it doesn't affect anyone else who clones the project.
</Info>
</Accordion>
@@ -250,7 +250,7 @@ These flags work on every command, not only on `infisical profile`.
</Accordion>
<Accordion title="--org">
- Use a specific organization for this command. Name it by name, slug, or id. The default organization of the profile does not change.
+ Use a specific organization for this command. Name it by name, slug, or id. The default organization of the profile doesn't change.
```bash
infisical --org globex-inc secrets
diff --git a/docs/self-hosting/configuration/envars.mdx b/docs/self-hosting/configuration/envars.mdx
index 1794bf68c9..e4f1153118 100644
--- a/docs/self-hosting/configuration/envars.mdx
+++ b/docs/self-hosting/configuration/envars.mdx
@@ -131,7 +131,7 @@ Example values:
Defaults to `false` so an operator-configured forward proxy keeps working.
<Note>
- Enable this only if your instance does **not** rely on an outbound
+ Enable this only if your instance **doesn't** rely on an outbound
`HTTP_PROXY` / `HTTPS_PROXY` for egress. When a proxy is in use, the IP pin
can't extend past the proxy (the proxy resolves the target itself), so
leaving this off is the correct choice for proxied deployments.
@@ -283,7 +283,7 @@ and raising it is the right move.
<Tip>
Prefer scaling reads with `DB_READ_REPLICAS` over enlarging the primary pool. A connection pooler such as
PgBouncer or RDS Proxy is only worth the extra hop and failure domain once instance count alone pushes you
- near `max_connections`, and note that a pooler in transaction mode does **not** reclaim connections held
+ near `max_connections`, and note that a pooler in transaction mode **doesn't** reclaim connections held
open inside a transaction.
</Tip>