Add docs, Makefile
This commit is contained in:
30
docs/gitlab-project-manager.md
Normal file
30
docs/gitlab-project-manager.md
Normal file
@ -0,0 +1,30 @@
|
||||
## gitlab-project-manager
|
||||
|
||||
Find and use GitLab projects locally
|
||||
|
||||
### Synopsis
|
||||
|
||||
Finds GitLab projects using fuzzy-find, remembering
|
||||
your chosen term for the project as an alias, and offers helpful
|
||||
shortcuts for moving around in projects and opening your code
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
-h, --help help for gitlab-project-manager
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager alias](gitlab-project-manager_alias.md) - Manage project aliases
|
||||
* [gitlab-project-manager cache](gitlab-project-manager_cache.md) - Manage GitLab project cache
|
||||
* [gitlab-project-manager completion](gitlab-project-manager_completion.md) - Generate the autocompletion script for the specified shell
|
||||
* [gitlab-project-manager config](gitlab-project-manager_config.md) - GitLab Project Manager Configuration
|
||||
* [gitlab-project-manager docs](gitlab-project-manager_docs.md) - Generate documentation for git-project-manager
|
||||
* [gitlab-project-manager project](gitlab-project-manager_project.md) - Use a GitLab project
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
32
docs/gitlab-project-manager_alias.md
Normal file
32
docs/gitlab-project-manager_alias.md
Normal file
@ -0,0 +1,32 @@
|
||||
## gitlab-project-manager alias
|
||||
|
||||
Manage project aliases
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manages project aliases, with options for
|
||||
listing, adding, and deleting.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for alias
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager](gitlab-project-manager.md) - Find and use GitLab projects locally
|
||||
* [gitlab-project-manager alias add](gitlab-project-manager_alias_add.md) - Add a project alias
|
||||
* [gitlab-project-manager alias delete](gitlab-project-manager_alias_delete.md) - Delete a project alias
|
||||
* [gitlab-project-manager alias list](gitlab-project-manager_alias_list.md) - List Aliases
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
34
docs/gitlab-project-manager_alias_add.md
Normal file
34
docs/gitlab-project-manager_alias_add.md
Normal file
@ -0,0 +1,34 @@
|
||||
## gitlab-project-manager alias add
|
||||
|
||||
Add a project alias
|
||||
|
||||
### Synopsis
|
||||
|
||||
Adds a project alias to a project
|
||||
project ID can be provided, or will otherwise use fuzzy find
|
||||
|
||||
```
|
||||
gitlab-project-manager alias add [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for add
|
||||
--projectID int Specify a project by ID
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager alias](gitlab-project-manager_alias.md) - Manage project aliases
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
34
docs/gitlab-project-manager_alias_delete.md
Normal file
34
docs/gitlab-project-manager_alias_delete.md
Normal file
@ -0,0 +1,34 @@
|
||||
## gitlab-project-manager alias delete
|
||||
|
||||
Delete a project alias
|
||||
|
||||
### Synopsis
|
||||
|
||||
Deletes aliases from projects
|
||||
project ID can be provided, or will otherwise use fuzzy find
|
||||
|
||||
```
|
||||
gitlab-project-manager alias delete [fuzzy project or alias] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
--projectID int Specify a project by ID
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager alias](gitlab-project-manager_alias.md) - Manage project aliases
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
32
docs/gitlab-project-manager_alias_list.md
Normal file
32
docs/gitlab-project-manager_alias_list.md
Normal file
@ -0,0 +1,32 @@
|
||||
## gitlab-project-manager alias list
|
||||
|
||||
List Aliases
|
||||
|
||||
### Synopsis
|
||||
|
||||
Lists all aliases by project
|
||||
|
||||
```
|
||||
gitlab-project-manager alias list [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager alias](gitlab-project-manager_alias.md) - Manage project aliases
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
35
docs/gitlab-project-manager_cache.md
Normal file
35
docs/gitlab-project-manager_cache.md
Normal file
@ -0,0 +1,35 @@
|
||||
## gitlab-project-manager cache
|
||||
|
||||
Manage GitLab project cache
|
||||
|
||||
### Synopsis
|
||||
|
||||
Contains sub-commands for managing project cache.
|
||||
The project cache keeps this speedy, without smashing against the GitLab
|
||||
API every time a new project is added / searched for
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for cache
|
||||
--ttl duration Duration before cache is re-built in go time.Duration format (default 48h0m0s)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager](gitlab-project-manager.md) - Find and use GitLab projects locally
|
||||
* [gitlab-project-manager cache clear](gitlab-project-manager_cache_clear.md) - Clear GitLab Project Cache
|
||||
* [gitlab-project-manager cache dump](gitlab-project-manager_cache_dump.md) - Dump GitLab project cache
|
||||
* [gitlab-project-manager cache load](gitlab-project-manager_cache_load.md) - Load GitLab Project Cache
|
||||
* [gitlab-project-manager cache unlock](gitlab-project-manager_cache_unlock.md) - unlock GitLab project cache
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
36
docs/gitlab-project-manager_cache_clear.md
Normal file
36
docs/gitlab-project-manager_cache_clear.md
Normal file
@ -0,0 +1,36 @@
|
||||
## gitlab-project-manager cache clear
|
||||
|
||||
Clear GitLab Project Cache
|
||||
|
||||
### Synopsis
|
||||
|
||||
Used to reset a project cache, forcing it to be rebuilt.
|
||||
|
||||
If --clearAliases is provided, will also reset aliases. Use with caution.
|
||||
|
||||
```
|
||||
gitlab-project-manager cache clear [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--clearAliases Will also clear aliases from the cache, use with caution
|
||||
-h, --help help for clear
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
--ttl duration Duration before cache is re-built in go time.Duration format (default 48h0m0s)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager cache](gitlab-project-manager_cache.md) - Manage GitLab project cache
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
34
docs/gitlab-project-manager_cache_dump.md
Normal file
34
docs/gitlab-project-manager_cache_dump.md
Normal file
@ -0,0 +1,34 @@
|
||||
## gitlab-project-manager cache dump
|
||||
|
||||
Dump GitLab project cache
|
||||
|
||||
### Synopsis
|
||||
|
||||
Dumps cache to display
|
||||
|
||||
```
|
||||
gitlab-project-manager cache dump [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --full Dumps entire cache
|
||||
-h, --help help for dump
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
--ttl duration Duration before cache is re-built in go time.Duration format (default 48h0m0s)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager cache](gitlab-project-manager_cache.md) - Manage GitLab project cache
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
36
docs/gitlab-project-manager_cache_load.md
Normal file
36
docs/gitlab-project-manager_cache_load.md
Normal file
@ -0,0 +1,36 @@
|
||||
## gitlab-project-manager cache load
|
||||
|
||||
Load GitLab Project Cache
|
||||
|
||||
### Synopsis
|
||||
|
||||
Used to initialize or update a new GitLab cache. With thousands
|
||||
of projects, it would be too much work to hit the API every time a user
|
||||
wants to find a new project.
|
||||
|
||||
```
|
||||
gitlab-project-manager cache load [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for load
|
||||
--ownerOnly Only load projects that you are owner of (default true)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
--ttl duration Duration before cache is re-built in go time.Duration format (default 48h0m0s)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager cache](gitlab-project-manager_cache.md) - Manage GitLab project cache
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
34
docs/gitlab-project-manager_cache_unlock.md
Normal file
34
docs/gitlab-project-manager_cache_unlock.md
Normal file
@ -0,0 +1,34 @@
|
||||
## gitlab-project-manager cache unlock
|
||||
|
||||
unlock GitLab project cache
|
||||
|
||||
### Synopsis
|
||||
|
||||
unlocks cache to display
|
||||
|
||||
```
|
||||
gitlab-project-manager cache unlock [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --force force unlocks cache (don't ask)
|
||||
-h, --help help for unlock
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
--ttl duration Duration before cache is re-built in go time.Duration format (default 48h0m0s)
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager cache](gitlab-project-manager_cache.md) - Manage GitLab project cache
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
34
docs/gitlab-project-manager_completion.md
Normal file
34
docs/gitlab-project-manager_completion.md
Normal file
@ -0,0 +1,34 @@
|
||||
## gitlab-project-manager completion
|
||||
|
||||
Generate the autocompletion script for the specified shell
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for gitlab-project-manager 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
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager](gitlab-project-manager.md) - Find and use GitLab projects locally
|
||||
* [gitlab-project-manager completion bash](gitlab-project-manager_completion_bash.md) - Generate the autocompletion script for bash
|
||||
* [gitlab-project-manager completion fish](gitlab-project-manager_completion_fish.md) - Generate the autocompletion script for fish
|
||||
* [gitlab-project-manager completion powershell](gitlab-project-manager_completion_powershell.md) - Generate the autocompletion script for powershell
|
||||
* [gitlab-project-manager completion zsh](gitlab-project-manager_completion_zsh.md) - Generate the autocompletion script for zsh
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
53
docs/gitlab-project-manager_completion_bash.md
Normal file
53
docs/gitlab-project-manager_completion_bash.md
Normal file
@ -0,0 +1,53 @@
|
||||
## gitlab-project-manager 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 <(gitlab-project-manager completion bash)
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
#### Linux:
|
||||
|
||||
gitlab-project-manager completion bash > /etc/bash_completion.d/gitlab-project-manager
|
||||
|
||||
#### macOS:
|
||||
|
||||
gitlab-project-manager completion bash > $(brew --prefix)/etc/bash_completion.d/gitlab-project-manager
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
```
|
||||
gitlab-project-manager completion bash
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for bash
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager completion](gitlab-project-manager_completion.md) - Generate the autocompletion script for the specified shell
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
44
docs/gitlab-project-manager_completion_fish.md
Normal file
44
docs/gitlab-project-manager_completion_fish.md
Normal file
@ -0,0 +1,44 @@
|
||||
## gitlab-project-manager 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:
|
||||
|
||||
gitlab-project-manager completion fish | source
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
gitlab-project-manager completion fish > ~/.config/fish/completions/gitlab-project-manager.fish
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
```
|
||||
gitlab-project-manager completion fish [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for fish
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager completion](gitlab-project-manager_completion.md) - Generate the autocompletion script for the specified shell
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
41
docs/gitlab-project-manager_completion_powershell.md
Normal file
41
docs/gitlab-project-manager_completion_powershell.md
Normal file
@ -0,0 +1,41 @@
|
||||
## gitlab-project-manager completion powershell
|
||||
|
||||
Generate the autocompletion script for powershell
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for powershell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
|
||||
gitlab-project-manager completion powershell | Out-String | Invoke-Expression
|
||||
|
||||
To load completions for every new session, add the output of the above command
|
||||
to your powershell profile.
|
||||
|
||||
|
||||
```
|
||||
gitlab-project-manager completion powershell [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for powershell
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager completion](gitlab-project-manager_completion.md) - Generate the autocompletion script for the specified shell
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
55
docs/gitlab-project-manager_completion_zsh.md
Normal file
55
docs/gitlab-project-manager_completion_zsh.md
Normal file
@ -0,0 +1,55 @@
|
||||
## gitlab-project-manager 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 <(gitlab-project-manager completion zsh)
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
|
||||
#### Linux:
|
||||
|
||||
gitlab-project-manager completion zsh > "${fpath[1]}/_gitlab-project-manager"
|
||||
|
||||
#### macOS:
|
||||
|
||||
gitlab-project-manager completion zsh > $(brew --prefix)/share/zsh/site-functions/_gitlab-project-manager
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
|
||||
|
||||
```
|
||||
gitlab-project-manager completion zsh [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for zsh
|
||||
--no-descriptions disable completion descriptions
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager completion](gitlab-project-manager_completion.md) - Generate the autocompletion script for the specified shell
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
31
docs/gitlab-project-manager_config.md
Normal file
31
docs/gitlab-project-manager_config.md
Normal file
@ -0,0 +1,31 @@
|
||||
## gitlab-project-manager config
|
||||
|
||||
GitLab Project Manager Configuration
|
||||
|
||||
### Synopsis
|
||||
|
||||
Commands for managing configuration, particulary
|
||||
useful for seeding a new config file
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for config
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager](gitlab-project-manager.md) - Find and use GitLab projects locally
|
||||
* [gitlab-project-manager config generate](gitlab-project-manager_config_generate.md) - Generate a default configuration
|
||||
* [gitlab-project-manager config show](gitlab-project-manager_config_show.md) - Show GitLab Project Manager Configuration
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
35
docs/gitlab-project-manager_config_generate.md
Normal file
35
docs/gitlab-project-manager_config_generate.md
Normal file
@ -0,0 +1,35 @@
|
||||
## gitlab-project-manager config generate
|
||||
|
||||
Generate a default configuration
|
||||
|
||||
### Synopsis
|
||||
|
||||
Produces yaml to stdout that can be used
|
||||
to seed the configuration file
|
||||
|
||||
```
|
||||
gitlab-project-manager config generate [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for generate
|
||||
--prompt Prompt for settings
|
||||
--write Write config to file
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager config](gitlab-project-manager_config.md) - GitLab Project Manager Configuration
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
29
docs/gitlab-project-manager_config_show.md
Normal file
29
docs/gitlab-project-manager_config_show.md
Normal file
@ -0,0 +1,29 @@
|
||||
## gitlab-project-manager config show
|
||||
|
||||
Show GitLab Project Manager Configuration
|
||||
|
||||
```
|
||||
gitlab-project-manager config show [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for show
|
||||
-s, --sensitive Set to show sensitive fields
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager config](gitlab-project-manager_config.md) - GitLab Project Manager Configuration
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
29
docs/gitlab-project-manager_docs.md
Normal file
29
docs/gitlab-project-manager_docs.md
Normal file
@ -0,0 +1,29 @@
|
||||
## gitlab-project-manager docs
|
||||
|
||||
Generate documentation for git-project-manager
|
||||
|
||||
```
|
||||
gitlab-project-manager docs [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-d, --docsPath string specify output directory for documentation (default "./docs")
|
||||
-h, --help help for docs
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager](gitlab-project-manager.md) - Find and use GitLab projects locally
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
36
docs/gitlab-project-manager_project.md
Normal file
36
docs/gitlab-project-manager_project.md
Normal file
@ -0,0 +1,36 @@
|
||||
## gitlab-project-manager project
|
||||
|
||||
Use a GitLab project
|
||||
|
||||
### Synopsis
|
||||
|
||||
Switches to a GitLab project by name or alias
|
||||
If not found, will enter fzf mode. If not cloned, will clone
|
||||
the project locally.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for project
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager](gitlab-project-manager.md) - Find and use GitLab projects locally
|
||||
* [gitlab-project-manager project add](gitlab-project-manager_project_add.md) - Add a new GitLab project
|
||||
* [gitlab-project-manager project go](gitlab-project-manager_project_go.md) - Go to a GitLab project
|
||||
* [gitlab-project-manager project list](gitlab-project-manager_project_list.md) - List GitLab Projects
|
||||
* [gitlab-project-manager project open](gitlab-project-manager_project_open.md) - Open project in your IDE
|
||||
* [gitlab-project-manager project run](gitlab-project-manager_project_run.md) - Run the project (e.g. go run .)
|
||||
* [gitlab-project-manager project show](gitlab-project-manager_project_show.md) - Show detail for a GitLab project
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
33
docs/gitlab-project-manager_project_add.md
Normal file
33
docs/gitlab-project-manager_project_add.md
Normal file
@ -0,0 +1,33 @@
|
||||
## gitlab-project-manager project add
|
||||
|
||||
Add a new GitLab project
|
||||
|
||||
### Synopsis
|
||||
|
||||
Adds a new project to the local project path
|
||||
uses fuzzy find to locate the project
|
||||
|
||||
```
|
||||
gitlab-project-manager project add [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for add
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager project](gitlab-project-manager_project.md) - Use a GitLab project
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
36
docs/gitlab-project-manager_project_go.md
Normal file
36
docs/gitlab-project-manager_project_go.md
Normal file
@ -0,0 +1,36 @@
|
||||
## gitlab-project-manager project go
|
||||
|
||||
Go to a GitLab project
|
||||
|
||||
### Synopsis
|
||||
|
||||
Go to a project, searching by alias
|
||||
If project is not already cloned, its path will be built and it
|
||||
will be cloned from source control.
|
||||
|
||||
If conf.projects.alwaysPull, a git pull will be ran automatically
|
||||
|
||||
```
|
||||
gitlab-project-manager project go [fuzzy alias search] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for go
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager project](gitlab-project-manager_project.md) - Use a GitLab project
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
34
docs/gitlab-project-manager_project_list.md
Normal file
34
docs/gitlab-project-manager_project_list.md
Normal file
@ -0,0 +1,34 @@
|
||||
## gitlab-project-manager project list
|
||||
|
||||
List GitLab Projects
|
||||
|
||||
### Synopsis
|
||||
|
||||
List locally cloned projects. Optionally
|
||||
lists all projects in project cache
|
||||
|
||||
```
|
||||
gitlab-project-manager project list [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--all List all, not just cloned locally
|
||||
-h, --help help for list
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager project](gitlab-project-manager_project.md) - Use a GitLab project
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
39
docs/gitlab-project-manager_project_open.md
Normal file
39
docs/gitlab-project-manager_project_open.md
Normal file
@ -0,0 +1,39 @@
|
||||
## gitlab-project-manager project open
|
||||
|
||||
Open project in your IDE
|
||||
|
||||
### Synopsis
|
||||
|
||||
Opens the given project directory in the editor
|
||||
of your choice. Will find certain well-known entrypoints (e.g. main.go).
|
||||
|
||||
If your editor is set in your config file, it will be used, otherwise
|
||||
one will be found in your path from a list of known defaults.
|
||||
|
||||
```
|
||||
gitlab-project-manager project open [fuzzy alias search] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--binary string Path to editor binary
|
||||
--displayName string Set display name of editor (meant for config file)
|
||||
-h, --help help for open
|
||||
--openFlags string Optional flags when opening project (e.g. --reuse-window)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager project](gitlab-project-manager_project.md) - Use a GitLab project
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
33
docs/gitlab-project-manager_project_run.md
Normal file
33
docs/gitlab-project-manager_project_run.md
Normal file
@ -0,0 +1,33 @@
|
||||
## gitlab-project-manager project run
|
||||
|
||||
Run the project (e.g. go run .)
|
||||
|
||||
### Synopsis
|
||||
|
||||
Runs the current project. Tries to detect
|
||||
the language and runs accordingly (e.g. go run .)
|
||||
|
||||
```
|
||||
gitlab-project-manager project run [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for run
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager project](gitlab-project-manager_project.md) - Use a GitLab project
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
34
docs/gitlab-project-manager_project_show.md
Normal file
34
docs/gitlab-project-manager_project_show.md
Normal file
@ -0,0 +1,34 @@
|
||||
## gitlab-project-manager project show
|
||||
|
||||
Show detail for a GitLab project
|
||||
|
||||
### Synopsis
|
||||
|
||||
Shows detail for a particular project
|
||||
Will always fuzzy find
|
||||
|
||||
```
|
||||
gitlab-project-manager project show [fuzzy alias search] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--current Use project in CWD rather than fuzzy find
|
||||
-h, --help help for show
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--config string config file (default is ~/.config/gitlab-project-manager.yaml)
|
||||
--logLevel string Default log level -- info, warn, error, debug (default "info")
|
||||
--projectPath string Sets a path for local clones of projects
|
||||
--remote strings Specify remotes by host for any sub-command. Provide multiple times or comma delimited.
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [gitlab-project-manager project](gitlab-project-manager_project.md) - Use a GitLab project
|
||||
|
||||
###### Auto generated by spf13/cobra on 19-Dec-2024
|
Reference in New Issue
Block a user