# Testmo CLI

The Testmo CLI makes it easy to submit your automated test results to Testmo. It was specifically designed to make it easy to integrate Testmo into your CI/CD and build process, so you can easily send test results.

## Installation

Simply install the package by using NPM (usually installed on most systems already by default):

```
$ npm install -g @testmo/testmo-cli
```

This installs the `testmo` CLI tool globally on the system.

## Update

If you have already globally installed the Testmo CLI, you can update the package to the latest version like this:

```
$ npm update -g @testmo/testmo-cli
$ testmo --version
1.x.x
```

## Commands

Here's a list of available commands. Simply use `testmo help <command>` to learn more about the available options, details and examples.

```
Usage: testmo [options] [command]

Options:
  -V, --version                      Output the version number
  --ansi                             Force ANSI console output (colors, animations)
  --no-ansi                          Do not use ANSI console output (colors, animations)
  --debug                            Output additional debug information
  -h, --help                         Display help for command

Commands:
  automation:resources:add-artifact  Adds a new artifact to the local resource file to be submitted
                                     with an automation run
  automation:resources:add-field     Adds a new field to the local resource file to be submitted with
                                     an automation run
  automation:resources:add-link      Adds a new link to the local resource file to be submitted with
                                     an automation run
  automation:run:complete            Marks a test automation run as completed
  automation:run:create              Creates a new automation run for parallel execution
  automation:run:submit              Creates a new test automation run, submits test results and
                                     completes the run in a single step
  automation:run:submit-thread       Creates a new thread for an existing run, submits test results
                                     and completes the thread
  help                               Display help for command

Documentation:
  You can find detailed documentation about using the Testmo CLI here:

  https://docs.testmo.com
```

## Documentation

You can find detailed documentation about using the Testmo CLI here on our website:

https://docs.testmo.com/

## Automation linking

To link automation test results to manual test cases in your Testmo repository (automation
coverage tracking), use the separate `@testmo/testmo-link` package:

```bash
npm install -g @testmo/testmo-link
testmo-link --help
```

See the `@testmo/testmo-link` npm package for documentation and CI/CD examples.

## License

Copyright (c) Testmo GmbH (Berlin, Germany)<br>
All rights reserved.<br>
contact@testmo.com<br>
www.testmo.com