Skip to content

docs: fix toml file path #898

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

Open
lennessyy wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: fix toml file path #898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8c226a
docs: fix toml file path
lennessyy Jan 5, 2026
78eb1c3
docs: update yaml file
lennessyy Jan 5, 2026
3e46871
Merge branch 'main' into env-config-path-fix
lennessyy Jan 7, 2026
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
2 changes: 1 addition & 1 deletion internal/temporalcli/commands.gen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ func NewTemporalCommand(cctx *CommandContext) *TemporalCommand {
s.Command.PersistentFlags().StringVar(&s.Env, "env", "default", "Active environment name (`ENV`).")
cctx.BindFlagEnvVar(s.Command.PersistentFlags().Lookup("env"), "TEMPORAL_ENV")
s.Command.PersistentFlags().StringVar(&s.EnvFile, "env-file", "", "Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`.")
s.Command.PersistentFlags().StringVar(&s.ConfigFile, "config-file", "", "File path to read TOML config from, defaults to `$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. EXPERIMENTAL.")
s.Command.PersistentFlags().StringVar(&s.ConfigFile, "config-file", "", "File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. EXPERIMENTAL.")
s.Command.PersistentFlags().StringVar(&s.Profile, "profile", "", "Profile to use for config file. EXPERIMENTAL.")
s.Command.PersistentFlags().BoolVar(&s.DisableConfigFile, "disable-config-file", false, "If set, disables loading environment config from config file. EXPERIMENTAL.")
s.Command.PersistentFlags().BoolVar(&s.DisableConfigEnv, "disable-config-env", false, "If set, disables loading environment config from environment variables. EXPERIMENTAL.")
Expand Down
30 changes: 15 additions & 15 deletions internal/temporalcli/commands.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ commands:
type: string
description: |
File path to read TOML config from, defaults to
`$CONFIG_PATH/temporal/temporal.toml` where `$CONFIG_PATH` is defined
`$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined
as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on
macOS, and `%AppData%` on Windows.
experimental: true
Expand Down Expand Up @@ -1274,17 +1274,17 @@ commands:
```
temporal worker deployment manager-identity [command] [options]
```

When present, `ManagerIdentity` is the identity of the user that has the
exclusive right to make changes to this Worker Deployment. Empty by default.
When set, users whose identity does not match the `ManagerIdentity` will not
be able to change the Worker Deployment.

This is especially useful in environments where multiple users (such as CLI
users and automated controllers) may interact with the same Worker Deployment.
`ManagerIdentity` allows different users to communicate with one another about
who is expected to make changes to the Worker Deployment.

The current Manager Identity is returned with `describe`:
```
temporal worker deployment describe \
Expand All @@ -1310,12 +1310,12 @@ commands:
```

Set the `ManagerIdentity` of a Worker Deployment given its Deployment Name.

When present, `ManagerIdentity` is the identity of the user that has the
exclusive right to make changes to this Worker Deployment. Empty by default.
When set, users whose identity does not match the `ManagerIdentity` will not
be able to change the Worker Deployment.

This is especially useful in environments where multiple users (such as CLI
users and automated controllers) may interact with the same Worker Deployment.
`ManagerIdentity` allows different users to communicate with one another about
Expand All @@ -1324,7 +1324,7 @@ commands:
```
temporal worker deployment manager-identity set [options]
```

For example:

```
Expand All @@ -1337,14 +1337,14 @@ commands:
Sets the Manager Identity of the Deployment to the identity of the user making
this request. If you don't specifically pass an identity field, the CLI will
generate your identity for you.

For example:
```
temporal worker deployment manager-identity set \
--deployment-name DeploymentName \
--manager-identity NewManagerIdentity
```

Sets the Manager Identity of the Deployment to any string.

options:
Expand Down Expand Up @@ -1373,12 +1373,12 @@ commands:
```

Unset the `ManagerIdentity` of a Worker Deployment given its Deployment Name.

When present, `ManagerIdentity` is the identity of the user that has the
exclusive right to make changes to this Worker Deployment. Empty by default.
When set, users whose identity does not match the `ManagerIdentity` will not
be able to change the Worker Deployment.

This is especially useful in environments where multiple users (such as CLI
users and automated controllers) may interact with the same Worker Deployment.
`ManagerIdentity` allows different users to communicate with one another about
Expand All @@ -1387,7 +1387,7 @@ commands:
```
temporal worker deployment manager-identity unset [options]
```

For example:

```
Expand All @@ -1410,7 +1410,7 @@ commands:
summary: List worker status information in a specific namespace (EXPERIMENTAL)
description: |
Get a list of workers to the specified namespace.

```
temporal worker list --namespace YourNamespace --query 'TaskQueue="YourTaskQueue"'
```
Expand All @@ -1427,7 +1427,7 @@ commands:
summary: Returns information about a specific worker (EXPERIMENTAL)
description: |
Look up information of a specific worker.

```
temporal worker describe --namespace YourNamespace --worker-instance-key YourKey
```
Expand Down Expand Up @@ -4979,7 +4979,7 @@ option-sets:
Temporal workflow headers in 'KEY=VALUE' format.
Keys must be identifiers, and values must be JSON values.
May be passed multiple times to set multiple Temporal headers.
Note: These are workflow headers, not gRPC headers.
Note: These are workflow headers, not gRPC headers.

- name: workflow-update-options
options:
Expand Down