Skip to content

docs: convert CLI command documentation from tables to definition lists #1505

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
Andriy Knysh (aknysh) merged 6 commits into from
Sep 24, 2025
Merged

docs: convert CLI command documentation from tables to definition lists #1505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d8aa07b
docs: convert CLI command documentation from tables to definition lists
osterman Sep 24, 2025
9b977d8
fix: revert Exit Codes section back to table format
osterman Sep 24, 2025
046ab3a
docs: add missing 'component' to available sections list in describe-…
osterman Sep 24, 2025
24229bc
docs: add missing --everything flag to vendor pull command
osterman Sep 24, 2025
c2bfc7b
Merge branch 'main' into use-definition-lists
osterman Sep 24, 2025
5277a03
Merge branch 'main' into use-definition-lists
aknysh Sep 24, 2025
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
55 changes: 40 additions & 15 deletions website/docs/cli/commands/atlantis/atlantis-generate-repo-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,46 @@ atmos atlantis generate repo-config --affected-only=true --clone-target-ref=true

## Flags

| Flag | Description | Required |
|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------|
| `--config-template` | Atlantis config template name | no |
| `--project-template` | Atlantis project template name | no |
| `--output-path` | Output path to write `atlantis.yaml` file | no |
| `--stacks` | Generate Atlantis projects for the specified stacks only (comma-separated values) | no |
| `--components` | Generate Atlantis projects for the specified components only (comma-separated values) | no |
| `--affected-only` | Generate Atlantis projects only for the Atmos components changed<br/>between two Git commits | no |
| `--ref` | [Git Reference](https://git-scm.com/book/en/v2/Git-Internals-Git-References) with which to compare the current working branch | no |
| `--sha` | Git commit SHA with which to compare the current working branch | no |
| `--ssh-key` | Path to PEM-encoded private key to clone private repos using SSH | no |
| `--ssh-key-password` | Encryption password for the PEM-encoded private key if the key contains<br/>a password-encrypted PEM block | no |
| `--repo-path` | Path to the already cloned target repository with which to compare the current branch.<br/>Conflicts with `--ref`, `--sha`, `--ssh-key` and `--ssh-key-password` | no |
| `--verbose` | Print more detailed output when cloning and checking out the target<br/>Git repository and processing the result | no |
| `--clone-target-ref` | Clone the target reference with which to compare the current branch.<br/>`atmos atlantis generate repo-config --affected-only=true --clone-target-ref=true`<br/><br/>The flag is only used when `--affected-only=true`<br/><br/>If set to `false` (default), the target reference will be checked out instead<br/>This requires that the target reference is already cloned by Git,<br/>and the information about it exists in the `.git` directory | no |
<dl>
<dt>`--config-template` <em>(optional)</em></dt>
<dd>Atlantis config template name.</dd>

<dt>`--project-template` <em>(optional)</em></dt>
<dd>Atlantis project template name.</dd>

<dt>`--output-path` <em>(optional)</em></dt>
<dd>Output path to write `atlantis.yaml` file.</dd>

<dt>`--stacks` <em>(optional)</em></dt>
<dd>Generate Atlantis projects for the specified stacks only (comma-separated values).</dd>

<dt>`--components` <em>(optional)</em></dt>
<dd>Generate Atlantis projects for the specified components only (comma-separated values).</dd>

<dt>`--affected-only` <em>(optional)</em></dt>
<dd>Generate Atlantis projects only for the Atmos components changed<br/>between two Git commits.</dd>

<dt>`--ref` <em>(optional)</em></dt>
<dd>[Git Reference](https://git-scm.com/book/en/v2/Git-Internals-Git-References) with which to compare the current working branch.</dd>

<dt>`--sha` <em>(optional)</em></dt>
<dd>Git commit SHA with which to compare the current working branch.</dd>

<dt>`--ssh-key` <em>(optional)</em></dt>
<dd>Path to PEM-encoded private key to clone private repos using SSH.</dd>

<dt>`--ssh-key-password` <em>(optional)</em></dt>
<dd>Encryption password for the PEM-encoded private key if the key contains<br/>a password-encrypted PEM block.</dd>

<dt>`--repo-path` <em>(optional)</em></dt>
<dd>Path to the already cloned target repository with which to compare the current branch.<br/>Conflicts with `--ref`, `--sha`, `--ssh-key` and `--ssh-key-password`.</dd>

<dt>`--verbose` <em>(optional)</em></dt>
<dd>Print more detailed output when cloning and checking out the target<br/>Git repository and processing the result.</dd>

<dt>`--clone-target-ref` <em>(optional)</em></dt>
<dd>Clone the target reference with which to compare the current branch.<br/>`atmos atlantis generate repo-config --affected-only=true --clone-target-ref=true`<br/><br/>The flag is only used when `--affected-only=true`<br/><br/>If set to `false` (default), the target reference will be checked out instead<br/>This requires that the target reference is already cloned by Git,<br/>and the information about it exists in the `.git` directory.</dd>
</dl>

:::info

Expand Down
46 changes: 32 additions & 14 deletions website/docs/cli/commands/aws/aws-eks-update-kubeconfig.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,38 @@ atmos aws eks update-kubeconfig --verbose=true

## Arguments

| Argument | Description | Required |
|:------------|:----------------|:---------|
| `component` | Atmos component | no |
<dl>
<dt>`component` <em>(optional)</em></dt>
<dd>Atmos component.</dd>
</dl>

## Flags

| Flag | Description | Alias | Required |
|:---------------|:--------------------------------------------------------------------------------------------|:------|:---------|
| `--stack` | Atmos stack | `-s` | no |
| `--profile` | AWS profile to use to authenticate to the EKS cluster | | no |
| `--role-arn` | AWS IAM role ARN to use to authenticate to the EKS cluster | | no |
| `--name` | EKS cluster name | | no |
| `--region` | AWS region | | no |
| `--kubeconfig` | `kubeconfig` filename to append with the configuration | | no |
| `--alias` | Alias for the cluster context name. Defaults to match cluster ARN | | no |
| `--dry-run` | Print the merged kubeconfig to stdout instead of writing it to the specified file | | no |
| `--verbose` | Print more detailed output when writing the kubeconfig file, including the appended entries | | no |
<dl>
<dt>`--stack` / `-s` <em>(optional)</em></dt>
<dd>Atmos stack.</dd>

<dt>`--profile` <em>(optional)</em></dt>
<dd>AWS profile to use to authenticate to the EKS cluster.</dd>

<dt>`--role-arn` <em>(optional)</em></dt>
<dd>AWS IAM role ARN to use to authenticate to the EKS cluster.</dd>

<dt>`--name` <em>(optional)</em></dt>
<dd>EKS cluster name.</dd>

<dt>`--region` <em>(optional)</em></dt>
<dd>AWS region.</dd>

<dt>`--kubeconfig` <em>(optional)</em></dt>
<dd>`kubeconfig` filename to append with the configuration.</dd>

<dt>`--alias` <em>(optional)</em></dt>
<dd>Alias for the cluster context name. Defaults to match cluster ARN.</dd>

<dt>`--dry-run` <em>(optional)</em></dt>
<dd>Print the merged kubeconfig to stdout instead of writing it to the specified file.</dd>

<dt>`--verbose` <em>(optional)</em></dt>
<dd>Print more detailed output when writing the kubeconfig file, including the appended entries.</dd>
</dl>
7 changes: 4 additions & 3 deletions website/docs/cli/commands/completion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,10 @@ source <(atmos completion bash)

## Arguments

| Argument | Description | Required |
|:--------------|:--------------------------------------------------------------------|:---------|
| `shell_name ` | Shell name. Valid values are `bash`, `zsh`, `fish` and `powershell` | yes |
<dl>
<dt>`shell_name` <em>(required)</em></dt>
<dd>Shell name. Valid values are `bash`, `zsh`, `fish` and `powershell`.</dd>
</dl>
Comment thread
osterman marked this conversation as resolved.

:::info
Refer to [Command-line completion](https://en.wikipedia.org/wiki/Command-line_completion) for more details
Expand Down
42 changes: 29 additions & 13 deletions website/docs/cli/commands/describe/describe-component.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,22 +62,38 @@ atmos describe component vpc -s plat-ue2-prod --pager=more

## Arguments

| Argument | Description | Required |
|:------------|:----------------|:---------|
| `component` | Atmos component | yes |
<dl>
<dt>`component` <em>(required)</em></dt>
<dd>Atmos component.</dd>
</dl>

## Flags

| Flag | Description | Alias | Required |
|:----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------|:---------|
| `--stack` | Atmos stack | `-s` | yes |
| `--format` | Output format: `yaml` or `json` (`yaml` is default) | `-f` | no |
| `--file` | If specified, write the result to the file | | no |
| `--process-templates` | Enable/disable processing of all `Go` templates<br/>in Atmos stacks manifests when executing the command.<br/>Use the flag to see the component configuration<br/>before and after the templates are processed.<br/>If the flag is not provided, it's set to `true` by default.<br/>`atmos describe component <c> -s <stack> --process-templates=false` | | no |
| `--process-functions` | Enable/disable processing of all Atmos YAML functions<br/>in Atmos stacks manifests when executing the command.<br/>Use the flag to see the component configuration<br/>before and after the functions are processed.<br/>If the flag is not provided, it's set to `true` by default.<br/>`atmos describe component <c> -s <stack> --process-functions=false` | | no |
| `--skip` | Skip processing a specific Atmos YAML function<br/>in Atmos stacks manifests when executing the command.<br/>To specify more than one function,<br/>use multiple `--skip` flags, or separate the functions with a comma:<br/>`atmos describe component <c> -s <stack> --skip=terraform.output --skip=include`<br/>`atmos describe component <c> -s <stack> --skip=terraform.output,include` | | no |
| `--query` | Query the results of the command using `yq` expressions.<br/><br/>`atmos describe component <c> -s <stack> --query .vars.tags`<br/><br/>For more details, refer to https://mikefarah.gitbook.io/yq | `-q` | no |
| `--pager` | Disable/Enable the paging user experience | | |
<dl>
<dt>`--stack` / `-s` <em>(required)</em></dt>
<dd>Atmos stack.</dd>

<dt>`--format` / `-f` <em>(optional)</em></dt>
<dd>Output format: `yaml` or `json` (`yaml` is default).</dd>

<dt>`--file` <em>(optional)</em></dt>
<dd>If specified, write the result to the file.</dd>

<dt>`--process-templates` <em>(optional)</em></dt>
<dd>Enable/disable processing of all `Go` templates<br/>in Atmos stacks manifests when executing the command.<br/>Use the flag to see the component configuration<br/>before and after the templates are processed.<br/>If the flag is not provided, it's set to `true` by default.<br/>`atmos describe component <c> -s <stack> --process-templates=false`.</dd>

<dt>`--process-functions` <em>(optional)</em></dt>
<dd>Enable/disable processing of all Atmos YAML functions<br/>in Atmos stacks manifests when executing the command.<br/>Use the flag to see the component configuration<br/>before and after the functions are processed.<br/>If the flag is not provided, it's set to `true` by default.<br/>`atmos describe component <c> -s <stack> --process-functions=false`.</dd>

<dt>`--skip` <em>(optional)</em></dt>
<dd>Skip processing a specific Atmos YAML function<br/>in Atmos stacks manifests when executing the command.<br/>To specify more than one function,<br/>use multiple `--skip` flags, or separate the functions with a comma:<br/>`atmos describe component <c> -s <stack> --skip=terraform.output --skip=include`<br/>`atmos describe component <c> -s <stack> --skip=terraform.output,include`.</dd>

<dt>`--query` / `-q` <em>(optional)</em></dt>
<dd>Query the results of the command using `yq` expressions.<br/><br/>`atmos describe component <c> -s <stack> --query .vars.tags`<br/><br/>For more details, refer to https://mikefarah.gitbook.io/yq.</dd>

<dt>`--pager` <em>(optional)</em></dt>
<dd>Disable/Enable the paging user experience.</dd>
</dl>

## Output

Expand Down
Loading
Loading