ScoutOS CLI

The ScoutOS CLI allows one to interact with and update Scout workflows via CLI commands.

Table of Contents

• Getting Started
  • Setup
    • macOS
    • Linux
    • Windows
  • Connect to Your Scout Account
  • Initialize a Scout Project
  • Run a Workflow
  • Deploy a Workflow
• AI Workflow Project Structure
• Local Development

Getting Started

Setup

macOS

1. You can install the ScoutOS CLI using one of the following methods:

   • Automatic Installation:

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/scoutos/homebrew-scoutos-cli/main/install.sh)"

   • Manual Installation:

   brew tap scoutos/scoutos-cli
   brew install scoutos-cli

2. Now you should be able to use scout from your system! Try running scout --help to see if it works.

Linux

1. You can install the ScoutOS CLI using one of the following methods:

   • Automatic Installation:

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/scoutos/homebrew-scoutos-cli/main/install.sh)"

   • Manual Installation:

   brew tap scoutos/scoutos-cli
   brew install scoutos-cli

2. Now you should be able to use scout from your system! Try running scout --help to see if it works.

Windows

1. Download the Windows executable from the Latest Release.

2. Move and authorize the downloaded file:

# Move & rename executable
move scout-cli.exe C:\Windows\System32\scout.exe

3. Now you should be able to use scout from your system! Try running scout --help to see if it works.

4. If you want to remove the CLI, you can run:

del C:\Windows\System32\scout.exe

5. Note: You may have to grant the CLI permissions to write, read, and delete on your system.
   • icacls C:\Windows\System32\scout.exe /grant Everyone:F

Connect to Your Scout Account

Authenticate your local environment with:

scout link

This will securely connect your CLI to your Scout account.

Initialize a Scout Project

To start a new Scout project in your local directory, run:

scout init

The CLI will walk you through the setup process.

Run a Workflow

To run a specific workflow, use the following command:

scout workflows run <workflow_folder>

Replace <workflow_folder> with the folder name of the workflow you want to run

Deploy a Workflow

To deploy a workflow, use the following command:

scout workflows deploy <workflow_folder>

---

📁 AI Workflow Project Structure

A Scout AI Workflows as Code project follows a structured hierarchy:

/workflows
├── workflow_1/
│   ├── workflow.yml
│   ├── inputs/
│   │   ├── default.json
│   ├── meta.ts
│
├── workflow_2/
│   ├── workflow.yml
│   ├── inputs/
│   │   ├── default.json
│   ├── meta.ts
│
└── scout.config.ts

🔹 Key Components:

• workflow.yml – Defines each AI workflow.
• inputs/default.json – Stores default input parameters for the workflow.
• meta.ts – Metadata and additional configuration for the workflow.
• scout.config.js – Configuration settings for your Scout project.

Local Development

1. Clone and setup:

git clone [email protected]:scoutos/scout-cli.git
cd scout-cli

2. Install prerequisites:

• Install Deno
• Setup your development IDE environment

3. Now you should be able to run the code locally:

deno task dev --help

deno task dev workflows deploy --config ./examples/starter/workflows/source_mapping.yml

3. Now you should be able to use scout from your system! Trying running scout --help to see if it works.
4. If you want to remove the cli you can run sudo rm /usr/local/bin/scout.
5. Note: You may have to grant the cli permissions to write, read, delete to your system.