Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
coufalja committed Nov 6, 2023
1 parent 90f8294 commit 8ba7107
Show file tree
Hide file tree
Showing 17 changed files with 224 additions and 60 deletions.
3 changes: 2 additions & 1 deletion docs/scccmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ Tool currently provides functionality to get (download) config file from server.

```
-h, --help help for scccmd
--log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO

* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell
* [scccmd decrypt](scccmd_decrypt.md) - Decrypt the value server-side and prints the response
* [scccmd diff](scccmd_diff.md) - Diff the config from the given config server
* [scccmd encrypt](scccmd_encrypt.md) - Encrypt the value server-side and prints the response
Expand Down
30 changes: 30 additions & 0 deletions docs/scccmd_completion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## scccmd completion

Generate the autocompletion script for the specified shell

### Synopsis

Generate the autocompletion script for scccmd for the specified shell.
See each sub-command's help for details on how to use the generated script.


### Options

```
-h, --help help for completion
```

### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO

* [scccmd](scccmd.md) - Spring Cloud Config management tool
* [scccmd completion bash](scccmd_completion_bash.md) - Generate the autocompletion script for bash
* [scccmd completion fish](scccmd_completion_fish.md) - Generate the autocompletion script for fish
* [scccmd completion powershell](scccmd_completion_powershell.md) - Generate the autocompletion script for powershell
* [scccmd completion zsh](scccmd_completion_zsh.md) - Generate the autocompletion script for zsh

49 changes: 49 additions & 0 deletions docs/scccmd_completion_bash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## scccmd 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 <(scccmd completion bash)

To load completions for every new session, execute once:

#### Linux:

scccmd completion bash > /etc/bash_completion.d/scccmd

#### macOS:

scccmd completion bash > $(brew --prefix)/etc/bash_completion.d/scccmd

You will need to start a new shell for this setup to take effect.


```
scccmd completion bash
```

### Options

```
-h, --help help for bash
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO

* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell

40 changes: 40 additions & 0 deletions docs/scccmd_completion_fish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## scccmd 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:

scccmd completion fish | source

To load completions for every new session, execute once:

scccmd completion fish > ~/.config/fish/completions/scccmd.fish

You will need to start a new shell for this setup to take effect.


```
scccmd completion fish [flags]
```

### Options

```
-h, --help help for fish
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO

* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell

37 changes: 37 additions & 0 deletions docs/scccmd_completion_powershell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## scccmd completion powershell

Generate the autocompletion script for powershell

### Synopsis

Generate the autocompletion script for powershell.

To load completions in your current shell session:

scccmd completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command
to your powershell profile.


```
scccmd completion powershell [flags]
```

### Options

```
-h, --help help for powershell
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO

* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell

51 changes: 51 additions & 0 deletions docs/scccmd_completion_zsh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## scccmd completion zsh

Generate the autocompletion script for zsh

### Synopsis

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

source <(scccmd completion zsh)

To load completions for every new session, execute once:

#### Linux:

scccmd completion zsh > "${fpath[1]}/_scccmd"

#### macOS:

scccmd completion zsh > $(brew --prefix)/share/zsh/site-functions/_scccmd

You will need to start a new shell for this setup to take effect.


```
scccmd completion zsh [flags]
```

### Options

```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO

* [scccmd completion](scccmd_completion.md) - Generate the autocompletion script for the specified shell

6 changes: 1 addition & 5 deletions docs/scccmd_decrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Decrypt the value server-side and prints the response

### Synopsis

Decrypt the value server-side and prints the response

```
scccmd decrypt [flags]
```
Expand All @@ -21,7 +17,7 @@ scccmd decrypt [flags]
### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO
Expand Down
6 changes: 1 addition & 5 deletions docs/scccmd_diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Diff the config from the given config server

### Synopsis

Diff the config from the given config server

### Options

```
Expand All @@ -21,7 +17,7 @@ Diff the config from the given config server
### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO
Expand Down
6 changes: 1 addition & 5 deletions docs/scccmd_diff_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Diff the config files from the given config server

### Synopsis

Diff the config files from the given config server

```
scccmd diff files [flags]
```
Expand All @@ -22,7 +18,7 @@ scccmd diff files [flags]
```
-a, --application string name of the application to get the config for
--label string configuration label (default "master")
--log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
--profile string configuration profile (default "default")
-s, --source string address of the config server
--target-label string second label to diff with
Expand Down
6 changes: 1 addition & 5 deletions docs/scccmd_diff_values.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Diff the config values in specified format from the given config server

### Synopsis

Diff the config values in specified format from the given config server

```
scccmd diff values [flags]
```
Expand All @@ -22,7 +18,7 @@ scccmd diff values [flags]
```
-a, --application string name of the application to get the config for
--label string configuration label (default "master")
--log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
--profile string configuration profile (default "default")
-s, --source string address of the config server
--target-label string second label to diff with
Expand Down
6 changes: 1 addition & 5 deletions docs/scccmd_encrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Encrypt the value server-side and prints the response

### Synopsis

Encrypt the value server-side and prints the response

```
scccmd encrypt [flags]
```
Expand All @@ -21,7 +17,7 @@ scccmd encrypt [flags]
### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO
Expand Down
6 changes: 1 addition & 5 deletions docs/scccmd_gendoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Generates documentation for this tool in Markdown format

### Synopsis

Generates documentation for this tool in Markdown format

```
scccmd gendoc [flags]
```
Expand All @@ -20,7 +16,7 @@ scccmd gendoc [flags]
### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO
Expand Down
6 changes: 1 addition & 5 deletions docs/scccmd_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Get the config from the given config server

### Synopsis

Get the config from the given config server

### Options

```
Expand All @@ -19,7 +15,7 @@ Get the config from the given config server
### Options inherited from parent commands

```
--log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
```

### SEE ALSO
Expand Down
6 changes: 1 addition & 5 deletions docs/scccmd_get_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

Get the config files from the given config server

### Synopsis

Get the config files from the given config server

```
scccmd get files [flags]
```
Expand All @@ -22,7 +18,7 @@ scccmd get files [flags]
```
-a, --application string name of the application to get the config for
-l, --label string configuration label (default "master")
--log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
--log-level string command log level (options: [panic fatal error warning info debug trace]) (default "info")
-p, --profile string configuration profile (default "default")
-s, --source string address of the config server
```
Expand Down
Loading

0 comments on commit 8ba7107

Please sign in to comment.