diff --git a/docs/reference/commandline/tye-build.md b/docs/reference/commandline/tye-build.md index bd2dfafb..b9ff521e 100644 --- a/docs/reference/commandline/tye-build.md +++ b/docs/reference/commandline/tye-build.md @@ -4,15 +4,15 @@ `tye build` - Builds the application's containers. -## Synopsis +## Synopsis ```text -tye build [-?|-h|--help] [-v|--verbosity ] [] +tye build [-?|-h|--help] [-i|--interactive] [--tags ] [-v|--verbosity ] [-f|--framework ] [] ``` ## Description -The `tye build` command will build all of an application's project services into containers without deploying or pushing the containers remotely. +The `tye build` command will build all of an application's project services into containers without deploying or pushing the containers remotely. This command is useful for testing that all projects successfully build. @@ -30,10 +30,22 @@ If a directory path is specified, `tye build` will default to using these files, ## Options +- `-i|--interactive` + + Interactive mode. + +- `--tags ` + + Filter the group of running services by tag. + - `-v|--verbosity ` The verbosity of logs emitted by `tye build`. Defaults to Info. +- `-f|--framework ` + + The target framework hint to use for all cross-targeting projects with multiple TFMs. This value must be a valid target framework for each individual cross-targeting project. Non-crosstargeting projects will ignore this hint and the value TFM configured in tye.yaml will override this hint. + ## Examples diff --git a/docs/reference/commandline/tye-deploy.md b/docs/reference/commandline/tye-deploy.md index 75725055..d93bc6d8 100644 --- a/docs/reference/commandline/tye-deploy.md +++ b/docs/reference/commandline/tye-deploy.md @@ -4,10 +4,10 @@ `tye deploy` - Deploys the application to Kubernetes. -## Synopsis +## Synopsis ```text -tye deploy [-?|-h|--help] [-i|--interactive] [-n|--namespace ] [-v|--verbosity ] [-f|--force] [] +tye deploy [-?|-h|--help] [-i|--interactive] [-v|--verbosity ] [-n|--namespace ] [-f|--framework ] [--tags ] [--force] [] ``` ## Description @@ -27,7 +27,7 @@ The `tye deploy` command will deploy an application to Kubernetes. `tye deploy` > :bulb: Use `kubectl config view --minify --output 'jsonpath={..namespace}'` to view the current namespace. -> :warning: The `tye deploy` command requires access to a remote container registry. Images will be tagged using the registry configured in `tye.yaml` (if present), or using a registry supplied interactively at the command line. +> :warning: The `tye deploy` command requires access to a remote container registry. Images will be tagged using the registry configured in `tye.yaml` (if present), or using a registry supplied interactively at the command line. > :bulb: The `tye deploy` command uses Docker's credentials for pushing to the remote container registry. Make sure Docker is configured to push to your registry before running `tye deploy`. @@ -51,15 +51,23 @@ If a directory path is specified, `tye deploy` will default to using these files Does an interactive deployment that will accept input for values that are required by default. +- `-v|--verbosity ` + + The verbosity of logs emitted by `tye deploy`. Defaults to Info. + - `-n|--namespace` - + Specifies the Kubernetes namespace for deployment. Overrides a namespace value set in `tye.yaml`. -- `-v|--verbosity ` +- `-f|--framework ` - The verbosity of logs emitted by `tye deploy`. Defaults to Info. + The target framework hint to use for all cross-targeting projects with multiple TFMs. This value must be a valid target framework for each individual cross-targeting project. Non-crosstargeting projects will ignore this hint and the value TFM configured in tye.yaml will override this hint. + +- `--tags ` + + Filter the group of running services by tag. -- `-f|--force` +- `--force` Override validation and forces deployment. diff --git a/docs/reference/commandline/tye-init.md b/docs/reference/commandline/tye-init.md index 0b8362f8..5edf54c9 100644 --- a/docs/reference/commandline/tye-init.md +++ b/docs/reference/commandline/tye-init.md @@ -7,7 +7,7 @@ ## Synopsis ```text -tye init [-?|-h|--help] [-f|--force] [] +tye init [-?|-h|--help] [--force] [] ``` ## Description @@ -35,7 +35,7 @@ The path to either a file or directory to run `tye init` on. Can either be a yam ## Options -- `-f|--force` +- `--force` If a `tye.yaml` file is already present, overwrites it with a newly scaffolded `tye.yaml`. diff --git a/docs/reference/commandline/tye-push.md b/docs/reference/commandline/tye-push.md index 63edf022..18e43c87 100644 --- a/docs/reference/commandline/tye-push.md +++ b/docs/reference/commandline/tye-push.md @@ -4,10 +4,10 @@ `tye push` - Builds the application's containers and pushes them to the container registry. -## Synopsis +## Synopsis ```text -tye push [-?|-h|--help] [-i|--interactive] [-v|--verbosity ] [] +tye push [-?|-h|--help] [-i|--interactive] [-v|--verbosity ] [--tags ] [-f|--framework ] [--force] [] ``` ## Description @@ -16,7 +16,7 @@ The `tye push` command will build all of an application's project services into This command is useful if you want to use Tye to containerize .NET projects and manage deployment separately. -> :warning: The `tye push` command requires access to a remote container registry. Images will be tagged using the registry configured in `tye.yaml` (if present), or using a registry supplied interactively at the command line. +> :warning: The `tye push` command requires access to a remote container registry. Images will be tagged using the registry configured in `tye.yaml` (if present), or using a registry supplied interactively at the command line. > :bulb: The `tye push` command uses Docker's credentials for pushing to the remote container registry. Make sure Docker is configured to push to your registry before running `tye push`. @@ -42,6 +42,18 @@ If a directory path is specified, `tye push` will default to using these files, The verbosity of logs emitted by `tye deploy`. Defaults to Info. +- `--tags ` + + Filter the group of running services by tag. + +- `-f|--framework ` + + The target framework hint to use for all cross-targeting projects with multiple TFMs. This value must be a valid target framework for each individual cross-targeting project. Non-crosstargeting projects will ignore this hint and the value TFM configured in tye.yaml will override this hint. + +- `--force` + + Override validation and force push. + ## Examples - Push an application from the current directory: diff --git a/docs/reference/commandline/tye-run.md b/docs/reference/commandline/tye-run.md index 69ea2339..e147cc98 100644 --- a/docs/reference/commandline/tye-run.md +++ b/docs/reference/commandline/tye-run.md @@ -4,10 +4,10 @@ `tye run` - Runs the application. -## Synopsis +## Synopsis ```text -tye run [-?|-h|--help] [--no-build] [--port ] [--dtrace] [--debug] [-f|--force] [-v|--verbosity ] [] +tye run [-?|-h|--help] [--no-build] [--port ] [--logs ] [--dtrace ] [--metrics ] [--debug ] [--docker] [--dashboard] [--watch] [-f|--framework ] [--tags ] [-v|--verbosity ] [] ``` ## Description @@ -39,11 +39,11 @@ If a directory path is specified, `tye run` will default to using these files, i The port to run the dashboard on. Defaults to port 8000 if not specified. -- `--logs` +- `--logs ` Write structured application logs to the specified log providers. Supported providers are console, elastic (Elasticsearch), ai (ApplicationInsights), seq. -- `--dtrace ` +- `--dtrace ` Write distributed traces to the specified providers. Supported providers are zipkin. @@ -51,21 +51,37 @@ If a directory path is specified, `tye run` will default to using these files, i Waits for debugger attach to service. Specify `*` to wait to attach to all services. +- `--docker` + + Run projects as docker containers. + +- `--dashboard` + + Launch dashboard on run. + +- `--watch` + + Watches for file changes in all projects that are built by tye. Uses [`dotnet watch`](https://docs.microsoft.com/en-us/aspnet/core/tutorials/dotnet-watch?view=aspnetcore-3.1) to monitor for file changes. + +- `-f|--framework ` + + The target framework hint to use for all cross-targeting projects with multiple TFMs. This value must be a valid target framework for each individual cross-targeting project. Non-crosstargeting projects will ignore this hint and the value TFM configured in tye.yaml will override this hint. + +- `--tags ` + + Filter the group of running services by tag. + - `--verbosity ` - Sets the output verbosity of the process. - Possible values are - + Sets the output verbosity of the process. + Possible values are + * `debug` - display all logs that the process outputs * `info` - display only informational logs * `quiet` - display only warnings and errors The default value is `info` -- `--watch` - - Watches for file changes in all projects that are built by tye. Uses [`dotnet watch`](https://docs.microsoft.com/en-us/aspnet/core/tutorials/dotnet-watch?view=aspnetcore-3.1) to monitor for file changes. - ## Examples - Run an application in the current directory: diff --git a/docs/reference/commandline/tye-undeploy.md b/docs/reference/commandline/tye-undeploy.md index 6281cccb..57f66a86 100644 --- a/docs/reference/commandline/tye-undeploy.md +++ b/docs/reference/commandline/tye-undeploy.md @@ -4,10 +4,10 @@ `tye undeploy` - Removes a deployed application from Kubernetes. -## Synopsis +## Synopsis ```text -tye undeploy [-?|-h|--help] [-i|--interactive] [-n|--namespace ] [-v|--verbosity ] [--what-if] [] +tye undeploy [-?|-h|--help] [-n|--namespace ] [-i|--interactive] [-v|--verbosity ] [--tags ] [--what-if] [] ``` ## Description @@ -45,18 +45,22 @@ If a directory path is specified, `tye undeploy` will default to using these fil ## Options +- `-n|--namespace` + + Specifies the Kubernetes namespace for deployment. Overrides a namespace value set in `tye.yaml`. + - `-i|--interactive` Does an interactive undeploy that will prompt for deletion of each resource. -- `-n|--namespace` - - Specifies the Kubernetes namespace for deployment. Overrides a namespace value set in `tye.yaml`. - - `-v|--verbosity ` The verbosity of logs emitted by `tye undeploy`. Defaults to Info. +- `--tags ` + + Filter the group of running services by tag. + - `--what-if` Print each resource instead of deleting.