forked from flyteorg/flyte
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Flyte-Bot <admin@flyte.org> Co-authored-by: kumare3 <kumare3@users.noreply.github.com>
- Loading branch information
Showing
5 changed files
with
129 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
.. _flytectl_completion: | ||
|
||
flytectl completion | ||
------------------- | ||
|
||
Generate completion script | ||
|
||
Synopsis | ||
~~~~~~~~ | ||
|
||
|
||
To load completions: | ||
|
||
Bash: | ||
|
||
$ source <(flytectl completion bash) | ||
|
||
# To load completions for each session, execute once: | ||
# Linux: | ||
$ flytectl completion bash > /etc/bash_completion.d/flytectl | ||
# macOS: | ||
$ flytectl completion bash > /usr/local/etc/bash_completion.d/flytectl | ||
|
||
Zsh: | ||
|
||
# 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 for each session, execute once: | ||
$ flytectl completion zsh > "${fpath[1]}/_flytectl" | ||
|
||
# You will need to start a new shell for this setup to take effect. | ||
|
||
fish: | ||
|
||
$ flytectl completion fish | source | ||
|
||
# To load completions for each session, execute once: | ||
$ flytectl completion fish > ~/.config/fish/completions/flytectl.fish | ||
|
||
PowerShell: | ||
|
||
PS> flytectl completion powershell | Out-String | Invoke-Expression | ||
|
||
# To load completions for every new session, run: | ||
PS> flytectl completion powershell > flytectl.ps1 | ||
# and source this file from your PowerShell profile. | ||
|
||
|
||
:: | ||
|
||
flytectl completion [bash|zsh|fish|powershell] | ||
|
||
Options | ||
~~~~~~~ | ||
|
||
:: | ||
|
||
-h, --help help for completion | ||
|
||
Options inherited from parent commands | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
:: | ||
|
||
-c, --config string config file (default is $HOME/.flyte/config.yaml) | ||
-d, --domain string Specifies the Flyte project's domain. | ||
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") | ||
-p, --project string Specifies the Flyte project. | ||
|
||
SEE ALSO | ||
~~~~~~~~ | ||
|
||
* :doc:`flytectl` - flyetcl CLI tool | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
.. _flytectl_sandbox_status: | ||
|
||
flytectl sandbox status | ||
----------------------- | ||
|
||
Get the status of the sandbox environment. | ||
|
||
Synopsis | ||
~~~~~~~~ | ||
|
||
|
||
|
||
Status will retrieve the status of the Sandbox environment. Currently FlyteSandbox runs as a local docker container. | ||
This will return the docker status for this container | ||
|
||
Usage | ||
:: | ||
|
||
bin/flytectl sandbox status | ||
|
||
|
||
|
||
:: | ||
|
||
flytectl sandbox status [flags] | ||
|
||
Options | ||
~~~~~~~ | ||
|
||
:: | ||
|
||
-h, --help help for status | ||
|
||
Options inherited from parent commands | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
:: | ||
|
||
-c, --config string config file (default is $HOME/.flyte/config.yaml) | ||
-d, --domain string Specifies the Flyte project's domain. | ||
-o, --output string Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE") | ||
-p, --project string Specifies the Flyte project. | ||
|
||
SEE ALSO | ||
~~~~~~~~ | ||
|
||
* :doc:`flytectl_sandbox` - Used for testing flyte sandbox. | ||
|