Skip to content

Commit

Permalink
all the readme changes were lost and wrong docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dovholuknf committed Aug 30, 2024
1 parent 0e79edc commit e144367
Show file tree
Hide file tree
Showing 28 changed files with 633 additions and 459 deletions.
656 changes: 239 additions & 417 deletions README.md

Large diffs are not rendered by default.

36 changes: 0 additions & 36 deletions docs/zscp.md

This file was deleted.

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

To load completions for every new session, execute once:

#### Linux:

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

#### macOS:

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

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


```
zscp completion bash
```

### Options

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

### SEE ALSO

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

###### Auto generated by spf13/cobra on 29-Aug-2024
25 changes: 25 additions & 0 deletions docs/zscp/completion/completion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## zscp completion

Generate the autocompletion script for the specified shell

### Synopsis

Generate the autocompletion script for zscp 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
```

### SEE ALSO

* [zscp](../zscp.md) - Z(iti)scp, Carb-loaded ssh performs faster and stronger than ssh
* [zscp completion bash](bash/bash.md) - Generate the autocompletion script for bash
* [zscp completion fish](fish/fish.md) - Generate the autocompletion script for fish
* [zscp completion powershell](powershell/powershell.md) - Generate the autocompletion script for powershell
* [zscp completion zsh](zsh/zsh.md) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 29-Aug-2024
35 changes: 35 additions & 0 deletions docs/zscp/completion/fish/fish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## zscp 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:

zscp completion fish | source

To load completions for every new session, execute once:

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

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


```
zscp completion fish [flags]
```

### Options

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

### SEE ALSO

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

###### Auto generated by spf13/cobra on 29-Aug-2024
24 changes: 24 additions & 0 deletions docs/zscp/completion/help/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## zscp completion help

Help about any command

### Synopsis

Help provides help for any command in the application.
Simply type completion help [path to command] for full details.

```
zscp completion help [command] [flags]
```

### Options

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

### SEE ALSO

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

###### Auto generated by spf13/cobra on 29-Aug-2024
32 changes: 32 additions & 0 deletions docs/zscp/completion/powershell/powershell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## zscp completion powershell

Generate the autocompletion script for powershell

### Synopsis

Generate the autocompletion script for powershell.

To load completions in your current shell session:

zscp completion powershell | Out-String | Invoke-Expression

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


```
zscp completion powershell [flags]
```

### Options

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

### SEE ALSO

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

###### Auto generated by spf13/cobra on 29-Aug-2024
46 changes: 46 additions & 0 deletions docs/zscp/completion/zsh/zsh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## zscp 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 <(zscp completion zsh)

To load completions for every new session, execute once:

#### Linux:

zscp completion zsh > "${fpath[1]}/_zscp"

#### macOS:

zscp completion zsh > $(brew --prefix)/share/zsh/site-functions/_zscp

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


```
zscp completion zsh [flags]
```

### Options

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

### SEE ALSO

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

###### Auto generated by spf13/cobra on 29-Aug-2024
30 changes: 30 additions & 0 deletions docs/zscp/enroll/enroll.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## zscp enroll

enroll an identity

```
zscp enroll path/to/jwt [flags]
```

### Options

```
--ca string Additional trusted certificates
-c, --cert string The certificate to present when establishing a connection.
-h, --help help for enroll
-n, --idname string Names the identity. Ignored if not 3rd party auto enrollment
-j, --jwt string Enrollment token (JWT file). Required
-k, --key string The key to use with the certificate. Optionally specify the engine to use. supported engines: [parsec]
-a, --keyAlg RSA|EC Crypto algorithm to use when generating private key (default RSA)
-o, --out string Output configuration file.
-p, --password string Password for updb enrollment, prompted if not provided and necessary
--rm Remove the JWT on success
-u, --username string Username for updb enrollment, prompted if not provided and necessary
-v, --verbose Enable verbose logging
```

### SEE ALSO

* [zscp](../zscp.md) - Z(iti)scp, Carb-loaded ssh performs faster and stronger than ssh

###### Auto generated by spf13/cobra on 29-Aug-2024
24 changes: 24 additions & 0 deletions docs/zscp/help/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## zscp help

Help about any command

### Synopsis

Help provides help for any command in the application.
Simply type zscp help [path to command] for full details.

```
zscp help [command] [flags]
```

### Options

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

### SEE ALSO

* [zscp](../zscp.md) - Z(iti)scp, Carb-loaded ssh performs faster and stronger than ssh

###### Auto generated by spf13/cobra on 29-Aug-2024
28 changes: 28 additions & 0 deletions docs/zscp/mfa/enable/enable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## zscp mfa enable

Enable MFA. Enables MFA TOTP for the provided identity

```
zscp mfa enable [flags]
```

### Options

```
-c, --ZConfig string Path to ziti config file. default: /home/cd/.config/zssh/default.json
-p, --callbackPort string Port for Callback. default: 63275
-n, --clientID string IdP ClientID. default: openziti-client
-e, --clientSecret string IdP ClientSecret. default: (empty string - use PKCE)
--controllerUrl string the url of the controller to use. only used with --oidcOnly
-h, --help help for enable
-o, --oidc toggle OIDC mode. default: false
-a, --oidcIssuer string URL of the OpenID Connect provider. required
--oidcOnly toggle OIDC only mode. default: false
-q, --qr-code display MFA secret as ascii QR code: false
```

### SEE ALSO

* [zscp mfa](../mfa.md) - Manage MFA for the provided identity

###### Auto generated by spf13/cobra on 29-Aug-2024
24 changes: 24 additions & 0 deletions docs/zscp/mfa/help/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## zscp mfa help

Help about any command

### Synopsis

Help provides help for any command in the application.
Simply type mfa help [path to command] for full details.

```
zscp mfa help [command] [flags]
```

### Options

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

### SEE ALSO

* [zscp mfa](../mfa.md) - Manage MFA for the provided identity

###### Auto generated by spf13/cobra on 29-Aug-2024
17 changes: 17 additions & 0 deletions docs/zscp/mfa/mfa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## zscp mfa

Manage MFA for the provided identity

### Options

```
-h, --help help for mfa
```

### SEE ALSO

* [zscp](../zscp.md) - Z(iti)scp, Carb-loaded ssh performs faster and stronger than ssh
* [zscp mfa enable](enable/enable.md) - Enable MFA. Enables MFA TOTP for the provided identity
* [zscp mfa remove](remove/remove.md) - Remove MFA. Removes the MFA TOTP enablement for the provided identity

###### Auto generated by spf13/cobra on 29-Aug-2024
Loading

0 comments on commit e144367

Please sign in to comment.