@devassure/cli

DevAssure CLI

Command-line interface for DevAssure Testing Agent - Autonomous agent executing tests from natural language instructions.

Installation

Install DevAssure CLI globally using npm:

npm install -g @devassure/cli

Or using pnpm:

pnpm add -g @devassure/cli

After installation, verify it's working:

devassure version

Getting Started

1. Login

Authenticate with DevAssure:

devassure login

This will open your browser for OAuth2 authentication.

Alternatively, you can add an authentication token directly (recommended for CI/CD pipelines):

devassure add-token <your-token>

2. Initialize Your Project

Initialize DevAssure configuration in your project:

devassure init

This will:

• Create a .devassure folder with configuration files
• Prompt you for app URL, description, and personas
• Create a sample test file

3. Add Test Cases

Add test cases to the project by adding yaml files to the .devassure/tests folder in the project directory.

Example test case file:

```yaml
summary: Sample test case
steps:
  - Open the application url
  - Verify if the page loads successfully
  - Verify if there are no error messages
priority: P0
tags:
  - sanity
  - app-load

4. Run Tests

Run tests using the current directory as test cases directory:

devassure run-tests
# or use the alias
devassure run

5. Add Test Data

Any required test data can be added to .devassure/test_data.yaml in the project directory.

Example test data file:

default:
  url: 'http://localhost:3000'
  users:
    default:
      user_name: '[e-mail]'
      password: 12345678
    admin:
      user_name: '[e-mail]'
      password: 12345678

Commands

Authentication

• devassure login - Login to DevAssure using OAuth2 authentication
• devassure logout - Logout from DevAssure and clear stored tokens
• devassure add-token <token_value> - Add and validate an authentication token

Configuration

• devassure init - Initialize DevAssure configuration in the current directory
  • Creates .devassure folder with configuration files
  • Prompts for app URL, description, and personas
  • Creates sample test file

Running Tests

• devassure run-tests - Run tests using current directory as test cases directory
  • --path <path> - Project path (default: current directory)
  • --tag <tags> / --tags <tags> - Comma-separated tag values (e.g., --tag=tag1,tag2,tag3)
  • --priority <priorities> / --priorities <priorities> - Comma-separated priority values (e.g., --priority=P0,P1)
  • --folder <folders> / --folders <folders> - Comma-separated folder paths (e.g., --folder=admin/users,project/integration)
  • --query <query> / --queries <query> - Search query string (e.g., --query="my search query")
  • --filter <filter> / --filters <filter> - Raw filter string (takes precedence over other filter parameters, e.g., --filter="tag = tag1,tag2 && priority = P0")
  • --archive <folder> - Archive folder path; after the run, test reports are written as devassure-results-<session-id>.zip in this folder (relative paths are resolved from current directory)
  • Note: If --filter/--filters is provided, all other filter parameters (--tag, --priority, --folder, --query) are ignored
  • Alias: devassure run (same options apply)

Reports and Statistics

• devassure archive-report - Archive report results for a test session into a zip file

  • --output-dir <dir> - (Required) Output directory for the archived report zip
  • --session-id <sessionId> - Session ID to archive (either this or --last is required)
  • --last - Use the last executed session ID from the database
  • Runs devassure-agent archive-results and writes devassure-results-<session-id>.zip into the output directory

• devassure open-report - Open report server for a test session

  • --session-id <sessionId> - Session ID to open report for
  • --last - Open report for the last executed session
  • --archive <path> - Path to an archived zip file (e.g. from archive-report) to open; opens the report from the zip without using the database
  • Note: One of --archive, --session-id, or --last is required

• devassure summary - Print summary for a test session

  • --session-id <sessionId> - Session ID to summarize (either this or --last is required)
  • --last - Use the last executed session ID from the database
  • --json - Output summary as JSON (session_id, environment, scenarios, score, grouped_failures, passed_validations, duration_ms, duration_string)

• devassure stats - Show statistics about sessions, scenarios, and storage

  • Displays test session count, scenario count, and storage usage

Maintenance

• devassure cleanup - Clean up old sessions
  • --retain-days <days> - Retain sessions from the last N days
  • --retain-sessions <count> - Retain the last N sessions
  • If no options provided, prompts to delete all sessions

Utility

• devassure version - Show version of the CLI
• devassure help - Show help information

Global Options

• --verbose - Enable verbose logging for all commands

Configuration

Project files files are stored in:

• ~/.devassure/ (project-specific)

Examples

Basic Workflow

# 1. Login
devassure login

# 2. Initialize project
devassure init

# 3. Run tests
devassure run-tests

# 4. View report for last session
devassure open-report --last

Cleanup

# Keep only sessions from last 7 days
devassure cleanup --retain-days 7

# Keep only the last 10 sessions
devassure cleanup --retain-sessions 10

Filtering Tests

# Run tests with specific tags
devassure run-tests --tag=smoke,regression

# Run tests with specific priority
devassure run-tests --priority=P0,P1

# Run tests in specific folders
devassure run-tests --folder=admin/users,project/integration

# Run tests with a search query
devassure run-tests --query="login flow"

# Combine multiple filter parameters
devassure run-tests --tag=smoke --priority=P0 --folder=admin/users

# Use raw filter string (takes precedence over other filter parameters)
devassure run-tests --filter="tag = tag1,tag2 && priority = P0"

# All parameters support plural forms
devassure run-tests --tags=smoke,regression --priorities=P0,P1 --folders=admin/users

# Run tests and archive reports to a folder (zip created after run completes)
devassure run-tests --archive=./reports
devassure run --archive=/tmp/archives

Archiving and Opening Reports

# Archive the last session's report to a directory
devassure archive-report --output-dir=./reports --last

# Archive a specific session's report
devassure archive-report --output-dir=./reports --session-id=<session-id>

# Open report from an archived zip file
devassure open-report --archive=./reports/devassure-results-<session-id>.zip

Session Summary

# Print summary for the last session
devassure summary --last

# Print summary for a specific session
devassure summary --session-id=<session-id>

# Output summary as JSON
devassure summary --last --json

Support

For more information, visit DevAssure or run devassure help for command-specific help.