TrustGraph CLI Documentation

The TrustGraph Command Line Interface (CLI) provides comprehensive command-line access to all TrustGraph services. These tools wrap the REST and WebSocket APIs to provide convenient, scriptable access to TrustGraph functionality.

Installation

The CLI tools are installed as part of the trustgraph-cli package:

pip install trustgraph-cli

[!NOTE] The CLI version should match the version of TrustGraph being deployed.

Global Options

Most CLI commands support these common options:

  • -u, --api-url URL: TrustGraph API URL (default: $TRUSTGRAPH_URL or http://localhost:8088/)
  • -U, --user USER: User identifier (default: trustgraph)
  • -C, --collection COLLECTION: Collection identifier (default: default)
  • -f, --flow-id FLOW: Flow identifier (default: default)

Command Categories

System Administration & Configuration

System Setup:

Token Management:

Prompt Management:

Flow Management

Flow Operations:

Flow Class Management:

Knowledge Graph Management

Knowledge Core Operations:

Graph Data Operations:

Document Processing & Library Management

Document Loading:

Library Management:

Document Embeddings:

AI Services & Agent Interaction

Query & Interaction:

Tool & Prompt Management:

System Monitoring & Debugging

System Status:

Debugging:

Quick Start Examples

Basic Document Processing 

# Start a flow
tg-start-flow --flow-id my-flow --class-name document-processing

# Load a document
tg-load-text --flow-id my-flow --text "Your document content" --title "Test Document"

# Query the knowledge
tg-invoke-graph-rag --flow-id my-flow --query "What is the document about?"

Knowledge Management 

# List available knowledge cores
tg-show-kg-cores

# Load a knowledge core into a flow
tg-load-kg-core --flow-id my-flow --kg-core-id my-knowledge

# Query the knowledge graph
tg-show-graph --limit 100

Flow Management 

# Show available flow classes
tg-show-flow-classes

# Show running flows
tg-show-flows

# Stop a flow
tg-stop-flow --flow-id my-flow

Environment Variables

  • TRUSTGRAPH_URL: Default API URL for all commands
  • TRUSTGRAPH_USER: Default user identifier
  • TRUSTGRAPH_COLLECTION: Default collection identifier

Authentication

CLI commands inherit authentication from the environment or API configuration. See the main TrustGraph documentation for authentication setup.

Error Handling

All CLI commands provide:

  • Consistent error reporting
  • Exit codes (0 for success, non-zero for errors)
  • Detailed error messages for troubleshooting
  • Retry logic for network operations where appropriate

Table of contents