Skip to content

docs: cli gen #798

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
merged 1 commit into from
May 14, 2025
Merged

docs: cli gen #798

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
20 changes: 12 additions & 8 deletions docs/reference/cli/evcc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,25 @@ evcc [flags]
## Options

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--disable-auth Disable authentication (dangerous)
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--metrics Expose metrics
--profile Expose pprof profiles
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
--disable-auth Disable authentication (dangerous)
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--metrics Expose metrics
--profile Expose pprof profiles
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also

* [evcc charger](evcc_charger.md) - Query configured chargers
* [evcc checkconfig](evcc_checkconfig.md) - Check config file for errors
* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell
* [evcc config](evcc_config.md) - Dump database configuration
* [evcc configure](evcc_configure.md) - Create configuration (evcc.yaml)
* [evcc detect](evcc_detect.md) - Auto-detect compatible hardware
* [evcc device](evcc_device.md) - Query database-configured devices (debug only)
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_charger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,14 @@ evcc charger [name] [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_charger_ramp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,14 @@ evcc charger ramp [name] [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_checkconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ evcc checkconfig [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_completion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ See each sub-command's help for details on how to use the generated script.
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_completion_bash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,14 @@ evcc completion bash
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_completion_fish.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,14 @@ evcc completion fish [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_completion_powershell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,14 @@ evcc completion powershell [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_completion_zsh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,14 @@ evcc completion zsh [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
33 changes: 33 additions & 0 deletions docs/reference/cli/evcc_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# evcc config

Dump database configuration

```
evcc config [flags]
```

## Options

```
--class string Device class (charger|meter|vehicle|tariff|loadpoint|circuit)
```

## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also

* [evcc](evcc.md) - evcc - open source solar charging
* [evcc config delete](evcc_config_delete.md) - Delete device


26 changes: 26 additions & 0 deletions docs/reference/cli/evcc_config_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# evcc config delete

Delete device

```
evcc config delete <id> [flags]
```

## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also

* [evcc config](evcc_config.md) - Dump database configuration


13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,14 @@ evcc configure [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_detect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,14 @@ evcc detect [host ...] [subnet ...] [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_device.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ evcc device [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_discuss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ evcc discuss [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_dump.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ evcc dump [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_eebus-cert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ evcc eebus-cert [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
13 changes: 8 additions & 5 deletions docs/reference/cli/evcc_health.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ evcc health [flags]
## Options inherited from parent commands

```
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
-c, --config string Config file (default "~/evcc.yaml" or "/etc/evcc.yaml")
--database string Database location (default "~/.evcc/evcc.db")
-h, --help Help
--ignore-db Run command ignoring service database
-l, --log string Log level (fatal, error, warn, info, debug, trace) (default "info")
--log-headers Log headers
--template string Add custom template file (debug only)
--template-type string Custom template type (charger, meter, tariff, vehicle (debug only)
```

## See also
Expand Down
Loading