-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CLI section under reference (#633)
- Loading branch information
Showing
32 changed files
with
931 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"label": "CLI" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# evcc | ||
|
||
evcc - open source solar charging | ||
|
||
``` | ||
evcc [flags] | ||
``` | ||
|
||
## Options | ||
|
||
``` | ||
-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 | ||
--metrics Expose metrics | ||
--profile Expose pprof profiles | ||
``` | ||
|
||
## 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 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) | ||
* [evcc discuss](evcc_discuss.md) - Request support at Github Discussions (https://github.com/evcc-io/evcc/discussions/categories/erste-hilfe) | ||
* [evcc dump](evcc_dump.md) - Dump configuration | ||
* [evcc eebus-cert](evcc_eebus-cert.md) - Generate EEBUS certificate for using EEBUS compatible chargers | ||
* [evcc health](evcc_health.md) - Check application health | ||
* [evcc meter](evcc_meter.md) - Query configured meters | ||
* [evcc migrate](evcc_migrate.md) - Migrate yaml to database (overwrites db settings) | ||
* [evcc password](evcc_password.md) - Password administration | ||
* [evcc settings](evcc_settings.md) - Manage configuration settings | ||
* [evcc sponsor](evcc_sponsor.md) - Validate sponsor token | ||
* [evcc sunspec](evcc_sunspec.md) - Dump SunSpec model information | ||
* [evcc tariff](evcc_tariff.md) - Query configured tariff | ||
* [evcc token](evcc_token.md) - Generate token credentials | ||
* [evcc vehicle](evcc_vehicle.md) - Query configured vehicles | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# evcc charger | ||
|
||
Query configured chargers | ||
|
||
``` | ||
evcc charger [name] [flags] | ||
``` | ||
|
||
## Options | ||
|
||
``` | ||
-i, --current float Set maximum current | ||
--diagnose Diagnose | ||
-d, --disable Disable | ||
-e, --enable Enable | ||
-p, --phases int Set usable phases (1 or 3) | ||
-w, --wakeup Wake up | ||
``` | ||
|
||
## 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 | ||
``` | ||
|
||
## See also | ||
|
||
* [evcc](evcc.md) - evcc - open source solar charging | ||
* [evcc charger ramp](evcc_charger_ramp.md) - Ramp current from 6..16A in configurable steps | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# evcc charger ramp | ||
|
||
Ramp current from 6..16A in configurable steps | ||
|
||
``` | ||
evcc charger ramp [name] [flags] | ||
``` | ||
|
||
## Options | ||
|
||
``` | ||
--delay string ramp delay (default "1s") | ||
--digits string fractional digits (0..2) (default "0") | ||
``` | ||
|
||
## 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 | ||
``` | ||
|
||
## See also | ||
|
||
* [evcc charger](evcc_charger.md) - Query configured chargers | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# evcc checkconfig | ||
|
||
Check config file for errors | ||
|
||
## Synopsis | ||
|
||
Check the (specified or default) config file for errors. Note that | ||
checkconfig only checks the config file for parsing errors and does | ||
not check that individual device configurations are valid. | ||
|
||
``` | ||
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 | ||
``` | ||
|
||
## See also | ||
|
||
* [evcc](evcc.md) - evcc - open source solar charging | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# evcc completion | ||
|
||
Generate the autocompletion script for the specified shell | ||
|
||
## Synopsis | ||
|
||
Generate the autocompletion script for evcc for the specified shell. | ||
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 | ||
``` | ||
|
||
## See also | ||
|
||
* [evcc](evcc.md) - evcc - open source solar charging | ||
* [evcc completion bash](evcc_completion_bash.md) - Generate the autocompletion script for bash | ||
* [evcc completion fish](evcc_completion_fish.md) - Generate the autocompletion script for fish | ||
* [evcc completion powershell](evcc_completion_powershell.md) - Generate the autocompletion script for powershell | ||
* [evcc completion zsh](evcc_completion_zsh.md) - Generate the autocompletion script for zsh | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# evcc completion bash | ||
|
||
Generate the autocompletion script for bash | ||
|
||
## Synopsis | ||
|
||
Generate the autocompletion script for the bash shell. | ||
|
||
This script depends on the 'bash-completion' package. | ||
If it is not installed already, you can install it via your OS's package manager. | ||
|
||
To load completions in your current shell session: | ||
|
||
``` | ||
source <(evcc completion bash) | ||
``` | ||
|
||
To load completions for every new session, execute once: | ||
|
||
### Linux: | ||
|
||
``` | ||
evcc completion bash > /etc/bash_completion.d/evcc | ||
``` | ||
|
||
### macOS: | ||
|
||
``` | ||
evcc completion bash > $(brew --prefix)/etc/bash_completion.d/evcc | ||
``` | ||
|
||
You will need to start a new shell for this setup to take effect. | ||
|
||
|
||
``` | ||
evcc completion bash | ||
``` | ||
|
||
## Options | ||
|
||
``` | ||
--no-descriptions disable completion descriptions | ||
``` | ||
|
||
## 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 | ||
``` | ||
|
||
## See also | ||
|
||
* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# evcc completion fish | ||
|
||
Generate the autocompletion script for fish | ||
|
||
## Synopsis | ||
|
||
Generate the autocompletion script for the fish shell. | ||
|
||
To load completions in your current shell session: | ||
|
||
``` | ||
evcc completion fish | source | ||
``` | ||
|
||
To load completions for every new session, execute once: | ||
|
||
``` | ||
evcc completion fish > ~/.config/fish/completions/evcc.fish | ||
``` | ||
|
||
You will need to start a new shell for this setup to take effect. | ||
|
||
|
||
``` | ||
evcc completion fish [flags] | ||
``` | ||
|
||
## Options | ||
|
||
``` | ||
--no-descriptions disable completion descriptions | ||
``` | ||
|
||
## 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 | ||
``` | ||
|
||
## See also | ||
|
||
* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# evcc completion powershell | ||
|
||
Generate the autocompletion script for powershell | ||
|
||
## Synopsis | ||
|
||
Generate the autocompletion script for powershell. | ||
|
||
To load completions in your current shell session: | ||
|
||
``` | ||
evcc completion powershell | Out-String | Invoke-Expression | ||
``` | ||
|
||
To load completions for every new session, add the output of the above command | ||
to your powershell profile. | ||
|
||
|
||
``` | ||
evcc completion powershell [flags] | ||
``` | ||
|
||
## Options | ||
|
||
``` | ||
--no-descriptions disable completion descriptions | ||
``` | ||
|
||
## 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 | ||
``` | ||
|
||
## See also | ||
|
||
* [evcc completion](evcc_completion.md) - Generate the autocompletion script for the specified shell | ||
|
||
|
Oops, something went wrong.