Skip to content

Commit

Permalink
docs: add info about running version in Usage
Browse files Browse the repository at this point in the history
  • Loading branch information
ejseqera committed Jan 10, 2024
1 parent 17421de commit 50ed162
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,18 +87,22 @@ export TOWER_ACCESS_TOKEN=<your access token>

## Usage

To confirm the installation of `seqerakit`, configuration of the Seqera Platform CLI and connection is working as expected:
To confirm the installation of `seqerakit`, configuration of the Seqera Platform CLI and connection is working as expected. This will run the `tw info` command under the hood:

```bash
seqerakit --info
```

Use the `-h` or `--help `parameter to list the available commands and their associated options:

Use the `--help` or `-h` parameter to list the available commands and their associated options:
```bash
seqerakit --help
```

Use `--version` or `-v` to retrieve the current version of your seqerakit installation:
```bash
seqerakit --version
```

### Dryrun

To print the commands that would executed with `tw` when using a YAML file, you can run `seqerakit` with the `--dryrun` flag:
Expand Down

0 comments on commit 50ed162

Please sign in to comment.