Enum Commands 

pub enum Commands {
    Index {
        path: PathBuf,
        workspace: PathBuf,
        ollama: bool,
        chunk_size: Option<usize>,
    },
    Ask {
        query: String,
        workspace: PathBuf,
        ollama: bool,
    },
    Tui,
    Setup {
        template: Option<String>,
        output: PathBuf,
    },
    Validate {
        config_file: PathBuf,
    },
    Init {
        config: PathBuf,
    },
    Load {
        document: PathBuf,
        config: Option<PathBuf>,
    },
    Query {
        query: String,
        config: Option<PathBuf>,
    },
    Entities {
        filter: Option<String>,
        config: Option<PathBuf>,
    },
    Stats {
        config: Option<PathBuf>,
    },
    Bench {
        config: PathBuf,
        book: PathBuf,
        questions: String,
    },
    Workspace {
        action: WorkspaceCommands,
    },
}

Variants

Index

Index a document into a workspace. No config file required.

Example: graphrag index ./book.txt Example: graphrag index ./book.txt --workspace ./my-graph --ollama

Fields

path: PathBuf

Path to document file (txt, md, pdf via plain text)

workspace: PathBuf

Workspace directory (created if missing)

ollama: bool

Enable Ollama LLM extraction (requires running ollama serve)

chunk_size: Option<usize>

Override chunk size (default 1000)

Ask

Ask a question against an indexed workspace. No config file required.

Example: graphrag ask "Who is Diotima?"

Fields

query: String

Question to ask

workspace: PathBuf

Workspace directory created by graphrag index

ollama: bool

Enable Ollama LLM for semantic answering

Tui

Start interactive TUI (default)

Setup

Interactive setup wizard - creates graphrag.toml with guided configuration

Fields

template: Option<String>

Template to use: general, legal, medical, financial, technical

output: PathBuf

Output path for configuration file

Validate

Validate a configuration file (TOML or JSON5)

Fields

config_file: PathBuf

Path to the configuration file to validate

Init

Initialize GraphRAG with configuration (deprecated: prefer TUI with /config)

Fields

config: PathBuf

Configuration file path

Load

Load a document into the knowledge graph (deprecated: prefer TUI with /load)

Fields

document: PathBuf

Document file path

config: Option<PathBuf>

Configuration file (required if not already initialized)

Query

Execute a query (deprecated: prefer TUI)

Fields

query: String

Query text

config: Option<PathBuf>

Configuration file (required if not already initialized)

Entities

List entities in the knowledge graph (deprecated: prefer TUI with /entities)

Fields

filter: Option<String>

Filter by name or type

config: Option<PathBuf>

Configuration file

Stats

Configuration file

Fields

config: Option<PathBuf>

Configuration file

Bench

Run full E2E benchmark (Init -> Load -> Query) in memory

Fields

config: PathBuf

Configuration file

book: PathBuf

Book text file

questions: String

Pipe-separated list of questions e.g. “Q1?|Q2?”

Workspace

Workspace management commands

Fields

action: WorkspaceCommands

Trait Implementations

impl FromArgMatches for Commands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Commands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand