Skip to main content

Use Cases

These examples demonstrate real-world workflows you can run with Nexroo CLI.

Table of Contents​

Prerequisites​

To run these examples, you'll need to have nexroo-cli installed. See: Install Nexroo

How to Use Workflows​

Pulling Workflows​

Pull a workflow from a GitHub repository:

# From official Nexroo examples
nexroo workflow pull @nexroo-ai/workflow-example:workflow-name

# From any GitHub repository
nexroo workflow pull @username/repo-name:workflow-name

# From a specific branch
nexroo workflow pull @username/repo-name/branch-name:workflow-name

# With a custom name
nexroo workflow pull @nexroo-ai/workflow-example:workflow-name my-custom-name

# Skip configuration prompt (useful for automation)
nexroo workflow pull @nexroo-ai/workflow-example:workflow-name --no-config

Running Workflows​

After pulling, run the workflow by its name:

# Run by workflow name
nexroo run workflow-name

# Or by custom name if you renamed it
nexroo run my-custom-name

# With additional options
nexroo run workflow-name --verbose
nexroo run workflow-name --payload '{"key": "value"}'

Configuring Workflows​

Configure or reconfigure a workflow:

nexroo workflow config workflow-name

Managing Workflows​

List installed workflows:

nexroo workflow list

List available workflows from the official repository:

nexroo workflow list --available

Delete a workflow:

nexroo workflow delete workflow-name

Working with Private Repositories​

For private repositories, set a GitHub Personal Access Token:

Option 1: Environment Variable (Recommended)

# Linux/Mac
export NEXROO_CLI_GIT_PAT=ghp_xxxxxxxxxxxxx

# Windows PowerShell
$env:NEXROO_CLI_GIT_PAT="ghp_xxxxxxxxxxxxx"

# Windows CMD
set NEXROO_CLI_GIT_PAT=ghp_xxxxxxxxxxxxx

Option 2: Configuration File

nexroo config set github_token ghp_xxxxxxxxxxxxx

Create a token at: https://github.com/settings/tokens

Required scopes:

  • repo (for private repositories)
  • public_repo (for public repositories only)

Use Cases​

Basic RAG API​

This is a basic RAG (Retrieval-Augmented Generation) API workflow that embeds documents.

Pull the workflow:

nexroo workflow pull @nexroo-ai/workflow-example:basic-rag-api

Run the workflow:

nexroo run basic-rag-api

For more details on running and configuring workflows, see How to Use Workflows.