Skip to main content

Commands

Enum Commands 

Source
pub enum Commands {
Show 51 variants Init(InitArgs), Remember(RememberArgs), RememberBatch(RememberBatchArgs), Ingest(Box<IngestArgs>), Recall(RecallArgs), Read(ReadArgs), List(ListArgs), Forget(ForgetArgs), Purge(PurgeArgs), Rename(RenameArgs), SplitBody(SplitBodyArgs), Edit(EditArgs), History(HistoryArgs), Restore(RestoreArgs), HybridSearch(HybridSearchArgs), Health(HealthArgs), Migrate(MigrateArgs), NamespaceDetect(NamespaceDetectArgs), Optimize(OptimizeArgs), Stats(StatsArgs), SyncSafeCopy(SyncSafeCopyArgs), Backup(BackupArgs), Vacuum(VacuumArgs), Link(LinkArgs), Unlink(UnlinkArgs), DeepResearch(DeepResearchArgs), Related(RelatedArgs), Graph(GraphArgs), Export(ExportArgs), Fts(FtsArgs), Vec(VecArgs), CodexModels(CodexModelsArgs), PruneRelations(PruneRelationsArgs), PruneNer(PruneNerArgs), Slots(SlotsArgs), Pending(PendingArgs), Embedding(EmbeddingArgs), PendingEmbeddings(PendingEmbeddingsArgs), CleanupOrphans(CleanupOrphansArgs), MemoryEntities(MemoryEntitiesArgs), Cache(CacheArgs), DeleteEntity(DeleteEntityArgs), Reclassify(ReclassifyArgs), RenameEntity(RenameEntityArgs), MergeEntities(MergeEntitiesArgs), Enrich(Box<EnrichArgs>), ReclassifyRelation(ReclassifyRelationArgs), NormalizeEntities(NormalizeEntitiesArgs), Completions(CompletionsArgs), DebugSchema(DebugSchemaArgs), Config(ConfigArgs),
}

Variants§

§

Init(InitArgs)

Initialize database and download embedding model

§

Remember(RememberArgs)

Save a memory with optional entity graph

§

RememberBatch(RememberBatchArgs)

Batch-create memories from NDJSON stdin (one invocation, one slot)

§

Ingest(Box<IngestArgs>)

Bulk-ingest every file under a directory as separate memories (NDJSON output)

§

Recall(RecallArgs)

Search memories semantically

§

Read(ReadArgs)

Read a memory by exact name

§

List(ListArgs)

List memories with filters

§

Forget(ForgetArgs)

Soft-delete a memory

§

Purge(PurgeArgs)

Permanently delete soft-deleted memories

§

Rename(RenameArgs)

Rename a memory preserving history

§

SplitBody(SplitBodyArgs)

Split an oversized memory body into N child memories (v1.1.03, GAP-V8)

§

Edit(EditArgs)

Edit a memory’s body or description

§

History(HistoryArgs)

List all versions of a memory

§

Restore(RestoreArgs)

Restore a memory to a previous version

§

HybridSearch(HybridSearchArgs)

Search using hybrid vector + full-text search

§

Health(HealthArgs)

Show database health

§

Migrate(MigrateArgs)

Apply pending schema migrations

§

NamespaceDetect(NamespaceDetectArgs)

Resolve namespace precedence for the current invocation

§

Optimize(OptimizeArgs)

Run PRAGMA optimize on the database

§

Stats(StatsArgs)

Show database statistics

§

SyncSafeCopy(SyncSafeCopyArgs)

Create a checkpointed copy safe for file sync

§

Backup(BackupArgs)

Back up the database using the SQLite Online Backup API

§

Vacuum(VacuumArgs)

Run VACUUM after checkpointing the WAL

Create an explicit relationship between two entities

Remove a specific relationship between two entities

§

DeepResearch(DeepResearchArgs)

Deep parallel multi-hop GraphRAG research

§

Related(RelatedArgs)

List memories connected via the entity graph

§

Graph(GraphArgs)

Export a graph snapshot in json, dot or mermaid

§

Export(ExportArgs)

Export memories as NDJSON (one JSON line per memory, plus a summary line)

§

Fts(FtsArgs)

FTS5 full-text search index management (rebuild or check)

§

Vec(VecArgs)

Vector index maintenance (orphan detection, purge, stats) — G39

§

CodexModels(CodexModelsArgs)

List codex OAuth models accepted by ChatGPT Pro (G33).

GAP-E2E-010 (v1.0.89): accepts --json as a no-op (JSON is always emitted on stdout) so the flag never breaks agent pipelines that append --json to every invocation.

§

PruneRelations(PruneRelationsArgs)

Bulk-delete all relationships of a given type (e.g. mentions)

§

PruneNer(PruneNerArgs)

Remove NER bindings (memory_entities rows) for an entity or all entities

§

Slots(SlotsArgs)

Inspect and manage cross-process LLM slot semaphore (GAP-004, v1.0.82)

§

Pending(PendingArgs)

Inspect and manage the remember checkpoint queue (GAP-001, v1.0.82)

§

Embedding(EmbeddingArgs)

Health and per-entry inspection of the pending-embeddings queue (GAP-005, v1.0.82)

§

PendingEmbeddings(PendingEmbeddingsArgs)

Batch operations over the pending-embeddings queue (GAP-005, v1.0.82)

§

CleanupOrphans(CleanupOrphansArgs)

Remove entities that have no memories and no relationships

§

MemoryEntities(MemoryEntitiesArgs)

List entities linked to a specific memory

§

Cache(CacheArgs)

Manage cached resources (embedding models, etc.)

§

DeleteEntity(DeleteEntityArgs)

Delete an entity and all its relationships from the graph

§

Reclassify(ReclassifyArgs)

Reclassify one entity or a batch of entities to a new type

§

RenameEntity(RenameEntityArgs)

Rename an entity preserving all relationships and memory bindings

§

MergeEntities(MergeEntitiesArgs)

Merge multiple source entities into a single target entity

§

Enrich(Box<EnrichArgs>)

Enrich graph memories and entities using an LLM provider

§

ReclassifyRelation(ReclassifyRelationArgs)

Reclassify relationship types across the graph using rules or LLM judgment

§

NormalizeEntities(NormalizeEntitiesArgs)

Normalize entity names (deduplicate, kebab-case, merge near-duplicates)

§

Completions(CompletionsArgs)

Generate shell completions for Bash, Zsh, Fish, PowerShell, or Elvish

§

DebugSchema(DebugSchemaArgs)

§

Config(ConfigArgs)

Manage API keys and diagnose provider configuration (v1.0.93)

Implementations§

Source§

impl Commands

Source

pub fn is_embedding_heavy(&self) -> bool

Returns true for subcommands that load the ONNX model locally.

Source

pub fn uses_cli_slot(&self) -> bool

Source

pub fn tolerates_missing_embedding_key(&self) -> bool

Read-only / no-embedding subcommands that MUST run without an embedding API key. init warms a best-effort smoke test internally and degrades to ok_no_embedding when the backend is unreachable; the enrich queue inspectors (--status / --list-dead / --requeue-dead / --prune-dead-orphans) never embed and never call the LLM. The eager OpenRouter key preflight in main must skip its hard-fail for these.

Trait Implementations§

Source§

impl Debug for Commands

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for Commands

Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Assign values from ArgMatches to self.
Source§

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

Assign values from ArgMatches to self.
Source§

impl Subcommand for Commands

Source§

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

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 Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more