Skip to content

fix(docs): document the correct default config file location #19

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
ctreatma merged 1 commit into from
Oct 6, 2025
Merged

fix(docs): document the correct default config file location #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func init() {
// Cobra supports persistent flags, which, if defined here,
// will be global for your application.

rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.cli.yaml)")
rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/equinix/equinix.yaml)")
}

// initConfig reads in config file and ENV variables if set.
Expand Down
2 changes: 1 addition & 1 deletion docs/equinix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Command-line interface for Equinix APIs
### Options

```
--config string config file (default is $HOME/.cli.yaml)
--config string config file (default is $HOME/equinix/equinix.yaml)
-h, --help help for equinix
```

Expand Down
2 changes: 1 addition & 1 deletion docs/equinix_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ equinix api [url-path] [flags]
### Options inherited from parent commands

```
--config string config file (default is $HOME/.cli.yaml)
--config string config file (default is $HOME/equinix/equinix.yaml)
```

### SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/equinix_completion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ See each sub-command's help for details on how to use the generated script.
### Options inherited from parent commands

```
--config string config file (default is $HOME/.cli.yaml)
--config string config file (default is $HOME/equinix/equinix.yaml)
```

### SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/equinix_completion_bash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ equinix completion bash
### Options inherited from parent commands

```
--config string config file (default is $HOME/.cli.yaml)
--config string config file (default is $HOME/equinix/equinix.yaml)
```

### SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/equinix_completion_fish.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ equinix completion fish [flags]
### Options inherited from parent commands

```
--config string config file (default is $HOME/.cli.yaml)
--config string config file (default is $HOME/equinix/equinix.yaml)
```

### SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/equinix_completion_powershell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ equinix completion powershell [flags]
### Options inherited from parent commands

```
--config string config file (default is $HOME/.cli.yaml)
--config string config file (default is $HOME/equinix/equinix.yaml)
```

### SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/equinix_completion_zsh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ equinix completion zsh [flags]
### Options inherited from parent commands

```
--config string config file (default is $HOME/.cli.yaml)
--config string config file (default is $HOME/equinix/equinix.yaml)
```

### SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/equinix_docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ equinix docs <destination>
### Options inherited from parent commands

```
--config string config file (default is $HOME/.cli.yaml)
--config string config file (default is $HOME/equinix/equinix.yaml)
```

### SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/equinix_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ equinix version [flags]
### Options inherited from parent commands

```
--config string config file (default is $HOME/.cli.yaml)
--config string config file (default is $HOME/equinix/equinix.yaml)
```

### SEE ALSO
Expand Down