Skip to content

Commit 26c82a2

Browse files
authored
Remove duplicated CLI Options section (#678)
## Description This PR fixes a bug in the docs where the "CLI options" section was included twice. This happened because [the original title-cased "CLI Options" header and all other headers were modified to sentence-case in this PR](#558) to match [the docs style guide](https://github.com/hashicorp/web-unified-docs/blob/main/docs/style-guide/general/titles-and-headings.md#use-sentence-case-for-titles-headings-and-navigation-labels). The "CLI Options" header was in a section that should never be directly edited because it is automatically generated by the update_website Makefile target in the tfc-agent repo. Changing the casing of the header in the docs repo directly make the update_website Makefile target not work as expected. Instead of replacing the existing "CLI Options" setting, it appended a new section because the header casing no longer matched what was expected. The means the content under "CLI options" was outdated and the content under "CLI Options" was the most up to date. This PR cleans that up and makes the existing warning about not editing this section a little easier to see. [I have a separate PR open to update the header to sentence-casing directly in the tfc-agent repo.](hashicorp/tfc-agent#1131) ## Screenshots ### Before <img width="1098" height="325" alt="Screenshot 2025-08-01 at 3 23 59 PM" src="https://github.com/user-attachments/assets/f23f3fbb-1867-4a71-8c30-ff1a90f502fa" /> ### After <img width="1093" height="332" alt="Screenshot 2025-08-04 at 4 01 00 PM" src="https://github.com/user-attachments/assets/dfcfeb8d-10e7-43c5-ac06-effa1fc7c20e" /> ## Related Links 1. [Jira ticket](https://hashicorp.atlassian.net/browse/TFDN-1100?atlOrigin=eyJpIjoiOGRkMjk1YWI1NzJiNDhjYmJjNGZlODQ1ZTU5YzZmZmQiLCJwIjoiaiJ9) 2. [Related PR](hashicorp/tfc-agent#1131)
2 parents 369c7a6 + fc8ac4a commit 26c82a2

File tree

1 file changed

+3
-143
lines changed
  • content/terraform-docs-agents/v1.23.x/docs/cloud-docs/agents

1 file changed

+3
-143
lines changed

content/terraform-docs-agents/v1.23.x/docs/cloud-docs/agents/agents.mdx

Lines changed: 3 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -175,11 +175,12 @@ Sample response:
175175
}
176176
```
177177

178-
<!--
178+
<!--
179+
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
179180
WARNING: This the CLI options section is auto-generated during agent release process.
180181
Do not edit this section directly as your changes will be overwritten.
182+
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
181183
-->
182-
183184
# CLI options
184185

185186

@@ -314,146 +315,6 @@ Sample response:
314315
Environment variable: `TFC_AGENT_REQUEST_FORWARDING`
315316

316317

317-
* `-h`:
318-
Display this message and exit.
319-
320-
* `-v`:
321-
Display the version and exit.
322-
323-
# CLI Options
324-
325-
326-
* `-name <name>`:
327-
An optional user-specified name for the agent. This name may be used in
328-
the HCP Terraform user interface to help easily identify the agent.
329-
330-
Default: `The agent's ephemeral ID, assigned during boot.`
331-
332-
Environment variable: `TFC_AGENT_NAME`
333-
334-
335-
* `-log-level <level>`:
336-
The log verbosity expressed as a level string. Level options include
337-
"trace", "debug", "info", "warn", and "error". Log levels have a
338-
progressive level of data sensitivy. The "info", "warn", and "error" levels
339-
are considered generally safe for log collection and don't include
340-
sensitive information. The "debug" log level may include internal system
341-
details, such as specific commands and arguments including paths to user
342-
data on the local filesystem. The "trace" log level is the most sensitive
343-
and may include personally identifiable information, secrets,
344-
pre-authorized internal URLs, and other sensitive material.
345-
346-
Default: `info`
347-
348-
Environment variable: `TFC_AGENT_LOG_LEVEL`
349-
350-
351-
* `-log-json`:
352-
Enable JSON logging mode.
353-
354-
Default: `false`
355-
356-
Environment variable: `TFC_AGENT_LOG_JSON`
357-
358-
359-
* `-data-dir <path>`:
360-
The path to a directory to store all agent-related data, including
361-
Terraform configurations, cached Terraform release archives, etc. It is
362-
important to ensure that the given directory is backed by plentiful
363-
storage.
364-
365-
Default: `~/.tfc-agent`
366-
367-
Environment variable: `TFC_AGENT_DATA_DIR`
368-
369-
370-
* `-cache-dir <path>`:
371-
The path to a directory to store all agent-related cache data, including
372-
cached Terraform release archives, policy binaries, etc. It is important to
373-
ensure that the given directory is backed by plentiful storage.
374-
375-
Default: `<data-dir>/cache`
376-
377-
Environment variable: `TFC_AGENT_CACHE_DIR`
378-
379-
380-
* `-single`:
381-
Enable single mode. This causes the agent to handle at most one job and
382-
immediately exit thereafter. Useful for running agents as ephemeral
383-
containers, VMs, or other isolated contexts with a higher-level scheduler
384-
or process supervisor.
385-
386-
Default: `false`
387-
388-
Environment variable: `TFC_AGENT_SINGLE`
389-
390-
391-
* `-auto-update`:
392-
Controls automatic core updates behavior. Acceptable values include
393-
"disabled", "patch", and "minor".
394-
395-
Default: `minor`
396-
397-
Environment variable: `TFC_AGENT_AUTO_UPDATE`
398-
399-
400-
* `-address <addr>`:
401-
The HTTP or HTTPS address of the HCP Terraform API.
402-
403-
Default: `https://app.terraform.io`
404-
405-
Environment variable: `TFC_ADDRESS`
406-
407-
408-
* `-token <token>`:
409-
The agent token to use when making requests to the HCP Terraform API.
410-
This token must be obtained from the API or UI. It is recommended to use
411-
the environment variable whenever possible for configuring this setting due
412-
to the sensitive nature of API tokens.
413-
414-
Required, no default.
415-
Environment variable: `TFC_AGENT_TOKEN`
416-
417-
418-
* `-otlp-address <addr>`:
419-
Optional host:port address of an OpenTelemetry collector to send telemetry
420-
data to, including metrics and tracing. Currently the agent connects to
421-
this address using the gRPC protocol.
422-
423-
Default: `none`
424-
425-
Environment variable: `TFC_AGENT_OTLP_ADDRESS`
426-
427-
428-
* `-otlp-cert-file <path>`:
429-
Optional path to a client TLS certificate file to load. When present, the
430-
given certificate is used to encrypt the client connection to the
431-
OpenTelemetry collector. When omitted, client connections are not secure.
432-
433-
Default: `none`
434-
435-
Environment variable: `TFC_AGENT_OTLP_CERT_FILE`
436-
437-
438-
* `-accept <job_types>`:
439-
Optional string of comma-separated job types that this agent may run.
440-
Acceptable job types are "plan", "apply", "policy", "assessment", "ingress",
441-
and "test". Do not put whitespace in between entries.
442-
443-
Default: `plan,apply,policy,assessment`
444-
445-
Environment variable: `TFC_AGENT_ACCEPT`
446-
447-
448-
* `-request-forwarding`:
449-
Enable handling of forwarded HTTP requests. Enable this option only if you
450-
are using product features which require it.
451-
452-
Default: `false`
453-
454-
Environment variable: `TFC_AGENT_REQUEST_FORWARDING`
455-
456-
457318
* `-hyok`:
458319
Enable handling HYOK requests for generating, re-encrypting, or decrypting data
459320
keys using your KMS. This is not required to handle runs on HYOK workspaces.
@@ -469,4 +330,3 @@ Sample response:
469330

470331
* `-v`:
471332
Display the version and exit.
472-

0 commit comments

Comments
 (0)