Skip to content

spacestation/kog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kog — Kognitos CLI

A command-line interface for the Kognitos automation platform. Manage organizations, workspaces, automations, runs, and more directly from your terminal.

Installation

Build from source

git clone https://github.com/kognitos/kog-cli.git
cd kog-cli
make build    # outputs ./kog binary
make install  # installs to $GOPATH/bin

Requires: Go 1.22+

Quick Start

# Authenticate with your personal access token
kog auth login

# Set default org and workspace
kog org list
kog workspace list --org <org-id>

# Run an automation
kog automation invoke --org <org-id> --workspace <ws-id> --automation <auto-id>

# Check run status
kog run list --org <org-id> --workspace <ws-id>

Configuration

Config is stored at ~/.config/kognitos/config.yaml (override with $KOG_CONFIG_DIR).

token: <personal-access-token>
org: <default-organization-id>
workspace: <default-workspace-id>
api_url: https://app.us-1.kognitos.com/api/v1

All config values can be overridden with environment variables:

Config Field Environment Variable
token KOG_TOKEN
org KOG_ORG
workspace KOG_WORKSPACE
api_url KOG_API_URL

Commands

Authentication

Command Description
kog auth login Store personal access token
kog auth logout Remove stored token
kog auth status Check authentication status

Organizations

Command Description
kog org list List all organizations
kog org get Get organization details
kog org users List users in an organization
kog org roles List roles in an organization
kog org invites List organization user invites
kog org invitation Get an organization invitation

Workspaces

Command Description
kog workspace list List workspaces
kog workspace get Get workspace details
kog workspace users List workspace users
kog workspace mine List current user's workspaces
kog workspace invites List workspace user invites

Automations

Command Description
kog automation list List automations in a workspace
kog automation get Get automation details
kog automation invoke Trigger an automation
kog automation revisions List automation revisions
kog automation triggers List triggers for an automation
kog automation create-trigger Create a trigger for an automation
kog automation connections List code connections for an automation
kog automation delete-connection Delete a workspace connection
kog automation delete-schedule Delete the schedule for an automation

Runs

Command Description
kog run list List automation runs
kog run get Get run details
kog run pause Pause a running automation
kog run continue Resume a paused run
kog run archive Archive a run

Files

Command Description
kog file upload Upload a file to an organization
kog file download Download a file
kog file metadata Get file metadata
kog file delete Delete a file

Exceptions

Command Description
kog exception list List exceptions
kog exception get Get exception details
kog exception count Count exceptions by automation

Events

Command Description
kog event list List agent events
kog event get Get event details
kog event stream Stream events in real-time
kog event create Create a new event

Books (Knowledge Base)

Command Description
kog book list List knowledge base books
kog book get Get book details
kog book versions List book versions
kog book procedures List procedures in a book
kog book concepts List concepts in a book

Dashboard

Command Description
kog dashboard insights Get automation insights and metrics
kog dashboard estimates Get cost estimates

Utility

Command Description
kog version Display CLI version
kog completion [shell] Generate shell completions (bash, zsh, fish, powershell)

Global Flags

Flag Short Description Env Variable
--org -o Organization ID KOG_ORG
--workspace -w Workspace ID KOG_WORKSPACE
--json Output as JSON
--no-color Disable colored output

Feature Completion Grid

Coverage of Kognitos platform capabilities in the CLI.

Platform Entities

Platform Feature CLI Support Commands Notes
Authentication ✅ Complete auth login, auth logout, auth status PAT-based auth
Organizations ✅ Complete org list, org get, org users, org roles Full read access
Workspaces 🔶 Partial workspace list, get, users, mine, invites Read-only; no create/update/delete
Automations 🔶 Partial automation list, get, invoke, revisions, triggers, create-trigger, connections, delete-connection, delete-schedule No create/update/delete automations themselves
Runs ✅ Complete run list, get, pause, continue, archive Full lifecycle management
Exceptions 🔶 Partial exception list, get, count Read-only; no resolve/dismiss
Events ✅ Complete event list, get, stream, create Includes real-time streaming
Files ✅ Complete file upload, download, metadata, delete Full CRUD
Books 🔶 Partial book list, get, versions, procedures, concepts Read-only; no create/update/delete
Dashboard 🔶 Partial dashboard insights, estimates Read-only analytics
Users 🔶 Partial via org users, workspace users, org invites, org invitation, workspace invites No standalone user management

Platform Capabilities

Capability CLI Support Notes
Automation Creation ❌ Not supported Automations are created via the web UI / Builder Agent
Automation Deployment (Draft/UAT/Prod) ❌ Not supported Deployment lifecycle managed via web UI
Exception Resolution ❌ Not supported Auto-resolved by Resolution Agent or via web UI
Connections / Credentials 🔶 Partial automation connections, delete-connection; no create
Integrations (130+ connectors) ❌ Not supported Configured via web UI
RBAC / Permissions ❌ Not supported Managed via web UI
Approval Gates ❌ Not supported Managed via web UI
Audit Trail 🔶 Partial Available via run get and event commands
Living SOPs / Procedures 🔶 Partial Read-only via book procedures
Real-time Monitoring 🔶 Partial event stream for live events; dashboard insights for metrics
JSON Output ✅ Complete All commands support --json flag
Shell Completions ✅ Complete bash, zsh, fish, powershell

Legend

Symbol Meaning
✅ Complete Full feature coverage
🔶 Partial Read-only or missing some operations
❌ Not supported Not available in CLI (web UI only)

Architecture

cmd/kog/          CLI entry point
internal/
  build/          Version and build info
  config/         YAML configuration management
  kogcmd/         Main command runner
  tableprinter/   Table formatting
pkg/
  cmd/            Command implementations (one package per domain)
  cmdutil/        Shared utilities (errors, auth, JSON output)
  iostreams/      TTY-aware I/O stream management
api/              REST API client with Bearer token auth

Development

make build   # Build binary
make test    # Run tests
make vet     # Run go vet
make lint    # Run golangci-lint
make clean   # Remove binary

Documentation

License

Proprietary. See LICENSE for details.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors