Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/probitas-test/cli

Command-line interface for Probitas - a scenario-based testing & workflow execution framework.
https://github.com/probitas-test/cli

cli probitas

Last synced: 5 months ago
JSON representation

Command-line interface for Probitas - a scenario-based testing & workflow execution framework.

Awesome Lists containing this project

README 

          
# ⚠️ DEPRECATED



Merged into https://github.com/probitas-test/probitas



---



# Probitas CLI



[![JSR](https://jsr.io/badges/@probitas/cli)](https://jsr.io/@probitas/cli)

[![Test](https://github.com/probitas-test/cli/actions/workflows/test.yml/badge.svg)](https://github.com/probitas-test/cli/actions/workflows/test.yml)

[![Publish](https://github.com/probitas-test/cli/actions/workflows/publish.yml/badge.svg)](https://github.com/probitas-test/cli/actions/workflows/publish.yml)

[![codecov](https://codecov.io/gh/probitas-test/cli/graph/badge.svg)](https://codecov.io/gh/probitas-test/cli)



Command-line interface for

[Probitas](https://github.com/probitas-test/probitas) - a scenario-based testing

& workflow execution framework.



## Installation



### Quick Install



Requires [Deno](https://deno.land/) v2.x or later.



```bash

curl -fsSL https://raw.githubusercontent.com/probitas-test/cli/main/install.sh | sh

```



**Environment variables:**



| Variable               | Description            | Default       |

| ---------------------- | ---------------------- | ------------- |

| `PROBITAS_VERSION`     | Version to install     | latest        |

| `PROBITAS_INSTALL_DIR` | Installation directory | `~/.deno/bin` |



```bash

# Install specific version

curl -fsSL https://raw.githubusercontent.com/probitas-test/cli/main/install.sh | PROBITAS_VERSION=0.1.0 sh



# Install to custom directory

curl -fsSL https://raw.githubusercontent.com/probitas-test/cli/main/install.sh | PROBITAS_INSTALL_DIR=/usr/local sh

```



### Using Homebrew (macOS/Linux)



```bash

# Add the tap and install

brew tap probitas-test/tap

brew install probitas



# Or install directly

brew install probitas-test/tap/probitas

```



Deno is installed automatically as a dependency.



### Using Nix



With [Nix](https://nixos.org/) and flakes enabled:



```bash

# Run directly without installing

nix run github:probitas-test/cli



# Install to profile

nix profile install github:probitas-test/cli

```



**Use in a flake (recommended):**



```nix

{

  inputs = {

    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

    probitas.url = "github:probitas-test/cli";

  };



  outputs = { nixpkgs, probitas, ... }:

    let

      system = "x86_64-linux"; # or "aarch64-darwin", etc.

      pkgs = import nixpkgs {

        inherit system;

        overlays = [ probitas.overlays.default ];

      };

    in {

      # Now you can use pkgs.probitas anywhere

      devShells.${system}.default = pkgs.mkShell {

        packages = [ pkgs.probitas ];

      };

    };

}

```



**NixOS / Home Manager:**



```nix

{

  nixpkgs.overlays = [ probitas.overlays.default ];

  environment.systemPackages = [ pkgs.probitas ];  # NixOS

  home.packages = [ pkgs.probitas ];               # Home Manager

}

```



## Usage



```bash

# Run all scenarios

probitas run



# Run scenarios with specific tag

probitas run -s tag:example



# Run with JSON reporter

probitas run --reporter json



# List scenarios without running

probitas list



# Format scenario files

probitas fmt



# Lint scenario files

probitas lint



# Type-check scenario files

probitas check



# Show help

probitas --help

```



## Commands



### `probitas run [paths...] [options]`



Execute scenario files and report results.



**Options:**



- `--select, -s ` - Filter scenarios by selector (can repeat)

- `--reporter ` - Output format: dot, list, json, tap (default: list)

- `--max-concurrency ` - Max parallel scenarios (0 = unlimited)

- `--sequential, -S` - Run scenarios sequentially (alias for

  --max-concurrency=1)

- `--max-failures ` - Stop after N failures (0 = continue all)

- `--fail-fast, -f` - Stop on first failure (alias for --max-failures=1)

- `--verbose, -v` - Verbose output (info level logging)

- `--quiet, -q` - Quiet output (errors only, fatal level logging)

- `--debug, -d` - Debug output (maximum detail)

- `--include ` - Include files matching pattern (can repeat)

- `--exclude ` - Exclude files matching pattern (can repeat)

- `--timeout ` - Scenario timeout (e.g., "30s", "5m", default: "30s")

- `--no-timeout` - Disable timeout (alias for --timeout 0)

- `--config ` - Path to config file

- `--env ` - Load environment variables from file (default: .env)

- `--no-env` - Skip loading .env file

- `--reload, -r` - Reload dependencies before running

- `--no-color` - Disable colored output



### `probitas list [paths...] [options]`



List discovered scenarios without running them.



**Options:**



- `--select, -s ` - Filter scenarios by selector (can repeat)

- `--include ` - Include files matching pattern (can repeat)

- `--exclude ` - Exclude files matching pattern (can repeat)

- `--json` - Output as JSON

- `--config ` - Path to config file

- `--env ` - Load environment variables from file (default: .env)

- `--no-env` - Skip loading .env file

- `--reload, -r` - Reload dependencies before listing

- `--verbose, -v` - Verbose output

- `--quiet, -q` - Quiet output

- `--debug, -d` - Debug output



### `probitas init [options]`



Initialize a new Probitas project with example files.



**Options:**



- `--directory, -d ` - Directory name to create (default: "probitas")

- `--force, -f` - Overwrite existing files

- `--verbose, -v` - Enable verbose output

- `--quiet, -q` - Suppress non-error output



**Examples:**



```bash

# Create probitas/ directory with example files

probitas init



# Create custom directory name

probitas init -d scenarios



# Overwrite existing files

probitas init --force

```



**Created files:**



- `example.probitas.ts` - Example scenario file

- `probitas.jsonc` - Configuration file



### `probitas fmt [paths...] [options]`



Format scenario files using Deno's formatter.



**Options:**



- `--include ` - Include pattern for file discovery

- `--exclude ` - Exclude pattern for file discovery

- `--config ` - Path to probitas config file

- `--verbose, -v` - Verbose output

- `--quiet, -q` - Suppress output

- `--debug, -d` - Debug output



**Examples:**



```bash

# Format all scenario files

probitas fmt



# Format scenarios in specific directory

probitas fmt api/



# Format with custom pattern

probitas fmt --include "e2e/**/*.probitas.ts"

```



**Note:** Runs `deno fmt --no-config` on discovered scenario files. Uses

includes/excludes from probitas config (same as run/list).



### `probitas lint [paths...] [options]`



Lint scenario files using Deno's linter.



**Options:**



- `--include ` - Include pattern for file discovery

- `--exclude ` - Exclude pattern for file discovery

- `--config ` - Path to probitas config file

- `--verbose, -v` - Verbose output

- `--quiet, -q` - Suppress output

- `--debug, -d` - Debug output



**Examples:**



```bash

# Lint all scenario files

probitas lint



# Lint scenarios in specific directory

probitas lint api/



# Lint with custom pattern

probitas lint --include "e2e/**/*.probitas.ts"

```



**Note:** Runs `deno lint --no-config` on discovered scenario files. Uses

includes/excludes from probitas config (same as run/list). Automatically

excludes rules: `no-import-prefix`, `no-unversioned-import`.



### `probitas check [paths...] [options]`



Type-check scenario files using Deno's type checker.



**Options:**



- `--include ` - Include pattern for file discovery

- `--exclude ` - Exclude pattern for file discovery

- `--config ` - Path to probitas config file

- `--verbose, -v` - Verbose output

- `--quiet, -q` - Suppress output

- `--debug, -d` - Debug output



**Examples:**



```bash

# Type-check all scenario files

probitas check



# Check scenarios in specific directory

probitas check api/



# Check with custom pattern

probitas check --include "e2e/**/*.probitas.ts"

```



**Note:** Runs `deno check --no-config` on discovered scenario files. Uses

includes/excludes from probitas config (same as run/list).



## Selectors



Selectors filter scenarios by name or tags:



- `login` - Match scenarios with "login" in name

- `tag:api` - Match scenarios tagged with "api"

- `!tag:slow` - Exclude scenarios tagged with "slow"

- `tag:api,tag:critical` - Match both tags (AND)

- Multiple `-s` flags combine with OR logic



## Exit Codes



- `0` - Success (all scenarios passed)

- `1` - Failure (one or more scenarios failed)

- `2` - Usage error (invalid arguments)

- `4` - No scenarios found



## Configuration



Create a configuration file in your project root:



```jsonc

{

  "includes": ["probitas/**/*.probitas.ts"],

  "excludes": ["**/*.skip.probitas.ts"],

  "reporter": "list", // Options: dot, list, json, tap

  "maxConcurrency": 4,

  "maxFailures": 0, // 0 = continue all

  "timeout": "30s",

  "selectors": ["!tag:wip"]

}

```



**Supported config file names** (in priority order):



1. `probitas.json`

2. `probitas.jsonc`

3. `.probitas.json`

4. `.probitas.jsonc`



The CLI searches for config files in the current directory and parent

directories. Configuration values can be overridden by command-line flags.



## Development



### Using Nix (recommended)



```bash

# Enter development shell with all dependencies

nix develop



# Or run commands directly

nix develop -c deno task test

```



### Without Nix



Requires [Deno](https://deno.land/) v2.x or later.



```bash

# Run tests

deno task test



# Run all checks

deno task verify

```



## License



See [LICENSE](LICENSE) file for details.