Skip to content
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.

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

Add CLI section under reference #633

Merged
merged 3 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,13 @@ $ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service. It should be run before any changes are committed, as it also includes link checking.

### Update CLI docs

CLI documentation is automatically generated.
Generation needs to be triggered manually.
Run this command inside the evcc core repository (e.g. `./evcc`).

```sh
go run main.go gendoc ../evcc-docs/docs/reference/cli/
```
3 changes: 3 additions & 0 deletions docs/reference/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "CLI"
}
43 changes: 43 additions & 0 deletions docs/reference/cli/evcc.md
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


35 changes: 35 additions & 0 deletions docs/reference/cli/evcc_charger.md
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


30 changes: 30 additions & 0 deletions docs/reference/cli/evcc_charger_ramp.md
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


29 changes: 29 additions & 0 deletions docs/reference/cli/evcc_checkconfig.md
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


29 changes: 29 additions & 0 deletions docs/reference/cli/evcc_completion.md
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


59 changes: 59 additions & 0 deletions docs/reference/cli/evcc_completion_bash.md
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


48 changes: 48 additions & 0 deletions docs/reference/cli/evcc_completion_fish.md
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


43 changes: 43 additions & 0 deletions docs/reference/cli/evcc_completion_powershell.md
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


Loading