README
¶
WSL Pro Service
The WSL Pro Service is the component that runs on each guest Ubuntu distro.
Usage
User commands
wsl-pro-service
WSL Pro Service
WSL Pro Service connects Ubuntu Pro for WSL agent to your distro.
wsl-pro-service COMMAND [flags]
-c, --config string configuration file path
-h, --help help for wsl-pro-service
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
wsl-pro-service completion
Generate the autocompletion script for the specified shell
Generate the autocompletion script for wsl-pro-service for the specified shell. See each sub-command's help for details on how to use the generated script.
-h, --help help for completion
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
wsl-pro-service completion bash
Generate the autocompletion script for bash
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 <(wsl-pro-service completion bash)
To load completions for every new session, execute once:
wsl-pro-service completion bash > /etc/bash_completion.d/wsl-pro-service
wsl-pro-service completion bash > $(brew --prefix)/etc/bash_completion.d/wsl-pro-service
You will need to start a new shell for this setup to take effect.
wsl-pro-service completion bash
-h, --help help for bash
--no-descriptions disable completion descriptions
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
wsl-pro-service completion fish
Generate the autocompletion script for fish
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
wsl-pro-service completion fish | source
To load completions for every new session, execute once:
wsl-pro-service completion fish > ~/.config/fish/completions/wsl-pro-service.fish
You will need to start a new shell for this setup to take effect.
wsl-pro-service completion fish [flags]
-h, --help help for fish
--no-descriptions disable completion descriptions
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
wsl-pro-service completion powershell
Generate the autocompletion script for powershell
Generate the autocompletion script for powershell.
To load completions in your current shell session:
wsl-pro-service completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command to your powershell profile.
wsl-pro-service completion powershell [flags]
-h, --help help for powershell
--no-descriptions disable completion descriptions
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
wsl-pro-service completion zsh
Generate the autocompletion script for zsh
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 <(wsl-pro-service completion zsh)
To load completions for every new session, execute once:
wsl-pro-service completion zsh > "${fpath[1]}/_wsl-pro-service"
wsl-pro-service completion zsh > $(brew --prefix)/share/zsh/site-functions/_wsl-pro-service
You will need to start a new shell for this setup to take effect.
wsl-pro-service completion zsh [flags]
-h, --help help for zsh
--no-descriptions disable completion descriptions
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
wsl-pro-service version
Returns version of agent and exits
wsl-pro-service version [flags]
-h, --help help for version
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
Hidden commands
Those commands are hidden from help and should primarily be used by the system or for debugging.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
wsl-pro-service
Package main is the windows-agent entry point.
|
Package main is the windows-agent entry point. |
|
wsl-pro-service/service
Package service represents the CLI service for Ubuntu Pro wsl service.
|
Package service represents the CLI service for Ubuntu Pro wsl service. |
|
generate
|
|
|
doc
Package doc is a helper sub-module so that the documentation generation tools have access to the commands to document in this module.
|
Package doc is a helper sub-module so that the documentation generation tools have access to the commands to document in this module. |
|
internal
|
|
|
commandservice
Package commandservice is the implementation of the wsl instance API.
|
Package commandservice is the implementation of the wsl instance API. |
|
consts
Package consts defines the constants used by the project
|
Package consts defines the constants used by the project |
|
daemon
Package daemon handles the GRPC daemon with systemd support.
|
Package daemon handles the GRPC daemon with systemd support. |
|
streams
Package streams abstracts the bi-directional gRPC stream and provides a faux server that mimics a unary call server.
|
Package streams abstracts the bi-directional gRPC stream and provides a faux server that mimics a unary call server. |
|
system
Package system contains utils to get system information relevant to the Agent.
|
Package system contains utils to get system information relevant to the Agent. |
|
testutils
Package testutils implements helper functions for frequently needed functionality in tests.
|
Package testutils implements helper functions for frequently needed functionality in tests. |