Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,33 +137,46 @@ Common SDK test arguments you might want to use for example:

**Note:** These extra arguments are applied to ALL Test Cases in the test run. Invalid arguments could cause test failures, so ensure the arguments are valid for the SDK test framework.

### test-run-execution-history
### Test Run Execution

Run `th-cli test-run-execution-history` to fetch the history of test runs. Use `--skip` and `--limit` for pagination
Run `th-cli test-run-execution` to fetch the history of test runs. Use `--skip` and `--limit` for pagination

Run `th-cli test-run-execution-history --id {id}` with a test run execution id to fetch the information for that test run.
Run `th-cli test-run-execution --id {id}` with a test run execution id to fetch the information for that test run.

For JSON respond, add `--json` to the command.

### create-project
### Project Create

Run `th-cli create-project --name {project name} --config {config file}` to create a new project. Project name is required.
Run `th-cli project create --name {project name} --config {config file}` to create a new project. Project name is required.

### list-projects
### Project List

Run `th-cli list-projects` to fetch projects. Use `--skip` and `--limit` for pagination. Use `--archived` to fetch archived projects only.
Run `th-cli projects list` to fetch projects. Use `--skip` and `--limit` for pagination. Use `--archived` to fetch archived projects only.

Run `th-cli list-projects --id {id}` with a project id to fetch the information for that specific project.

For JSON respond, add `--json` to the command.

### delete-project
### Project Delete

Run `th-cli delete-project --id {id}` to delete a project.
Run `th-cli project delete --id {id}` to delete a project.

### update-project
### Project Udpdate

Run `th-cli update-project --id {id} --config {config file}` to update a project. Both parameters are required. Config must be a full test environment config file.
Run `th-cli project update --id {id} --config {config file}` to update a project. Both parameters are required. Config must be a full test environment config file.

### Project Edit

Run `th-cli project edit --id {id}` to interactively edit a project's config in your
local editor ($VISUAL/$EDITOR). Only the `config` portion is editable. On save, the
CLI checks for new/unknown keys not present in the original config (the backend does
not reject all unknown fields) and asks for confirmation before persisting. If the
JSON is invalid or the server rejects the change, the editor reopens with your last
edit preserved so nothing is lost.

The editor used is picked from the `$VISUAL` environment variable first, then `$EDITOR`,
falling back to `vim`/`nano`/`vi` if neither is set. To use a different editor, set one
of these before running the command, e.g. `EDITOR=nano th-cli project edit --id {id}`.

## Command Colors
By default, the CLI application presents colored texts for all the available commands, specially for the log of test run executions from the `th-cli run-tests` command.
Expand Down
Loading
Loading