Skip to content

Commit

Permalink
📝 Change cli documentation to reflect the root change
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonBirchall committed Dec 28, 2024
1 parent 9193b06 commit 49993a9
Show file tree
Hide file tree
Showing 9 changed files with 282 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/lazy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## lazy

A simple CLI tool to commit changes to git with a message

### Synopsis

A longer description that spans multiple lines and likely contains
examples and usage of using your application. For example:

Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.

### Options

```
-h, --help help for lazy
-t, --toggle Help message for toggle
```

### SEE ALSO

* [lazy commit](lazy_commit.md) - Prints out the diff in the current directory and suggests commit messages
* [lazy completion](lazy_completion.md) - Generate the autocompletion script for the specified shell
* [lazy docs](lazy_docs.md) - Generates Markdown documentation for the CLI
* [lazy init](lazy_init.md) - Initializes the configuration file in the user's Linux profile

###### Auto generated by spf13/cobra on 28-Dec-2024
24 changes: 24 additions & 0 deletions docs/lazy_commit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## lazy commit

Prints out the diff in the current directory and suggests commit messages

### Synopsis

This command prints out the diff of the changes in the current directory.
It helps you see what changes have been made before committing them. It also suggests commit messages.

```
lazy commit [flags]
```

### Options

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

### SEE ALSO

* [lazy](lazy.md) - A simple CLI tool to commit changes to git with a message

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

Generate the autocompletion script for the specified shell

### Synopsis

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

* [lazy](lazy.md) - A simple CLI tool to commit changes to git with a message
* [lazy completion bash](lazy_completion_bash.md) - Generate the autocompletion script for bash
* [lazy completion fish](lazy_completion_fish.md) - Generate the autocompletion script for fish
* [lazy completion powershell](lazy_completion_powershell.md) - Generate the autocompletion script for powershell
* [lazy completion zsh](lazy_completion_zsh.md) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 28-Dec-2024
44 changes: 44 additions & 0 deletions docs/lazy_completion_bash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## lazy 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 <(lazy completion bash)

To load completions for every new session, execute once:

#### Linux:

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

#### macOS:

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

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


```
lazy completion bash
```

### Options

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

### SEE ALSO

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

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

lazy completion fish | source

To load completions for every new session, execute once:

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

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


```
lazy completion fish [flags]
```

### Options

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

### SEE ALSO

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

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

Generate the autocompletion script for powershell

### Synopsis

Generate the autocompletion script for powershell.

To load completions in your current shell session:

lazy completion powershell | Out-String | Invoke-Expression

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


```
lazy completion powershell [flags]
```

### Options

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

### SEE ALSO

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

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

To load completions for every new session, execute once:

#### Linux:

lazy completion zsh > "${fpath[1]}/_lazy"

#### macOS:

lazy completion zsh > $(brew --prefix)/share/zsh/site-functions/_lazy

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


```
lazy completion zsh [flags]
```

### Options

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

### SEE ALSO

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

###### Auto generated by spf13/cobra on 28-Dec-2024
24 changes: 24 additions & 0 deletions docs/lazy_docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## lazy docs

Generates Markdown documentation for the CLI

### Synopsis

This command generates Markdown documentation for the CLI commands
and saves it in the docs directory.

```
lazy docs [flags]
```

### Options

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

### SEE ALSO

* [lazy](lazy.md) - A simple CLI tool to commit changes to git with a message

###### Auto generated by spf13/cobra on 28-Dec-2024
24 changes: 24 additions & 0 deletions docs/lazy_init.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## lazy init

Initializes the configuration file in the user's Linux profile

### Synopsis

This command initializes a configuration file named .lazycommit.yaml
in the user's home directory.

```
lazy init [flags]
```

### Options

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

### SEE ALSO

* [lazy](lazy.md) - A simple CLI tool to commit changes to git with a message

###### Auto generated by spf13/cobra on 28-Dec-2024

0 comments on commit 49993a9

Please sign in to comment.