Use when the user wants to drive cognee from the terminal with cognee-cli — remember/recall/forget/improve memory commands, managing datasets and config, or database migrations.
日本語の概要は準備中です。原文の説明を表示しています。
Chat with a companion that knows your notes folder (a journal, an Obsidian vault, any .md or .txt files) and every earlier chat, using cognee memory with local databases. Use when someone wants to ask questions about their own notes, or to talk with a companion that remembers past conversations. Runs locally; reads the notes folder, writes only to cognee's memory.
インストールする前に、エージェントに与えられる指示の中身を確認できます。
Runs the self-hosted companion cookbook in examples/cookbooks/self_hosted_companion/. It
remembers a notes folder in the cognee dataset self_hosted_companion, then answers
messages about it; each chat is saved to memory, so a later one knows it. Setup, the
scripts and what each one does are in the cookbook's
README.md.
Run every command from the repo root.
Without a notes folder of the user's own, or to see it work first, leave out <folder>
below: the run then uses sample notes (the [setup] line says so). It needs only
LLM_API_KEY. Tell the user the answer comes from sample notes.
uv run python examples/cookbooks/self_hosted_companion/self_hosted_companion.py --check <folder>
with the notes folder the user named.
[setup] MISSING: line names one fix. Tell the user which line to fix,
using the README's "What it needs" table, and stop.--ask:
uv run python examples/cookbooks/self_hosted_companion/self_hosted_companion.py <folder> --ask "...".
Once the folder is remembered, later messages only need
uv run python examples/cookbooks/self_hosted_companion/scripts/chat.py --ask "...".[chat] companion>. Give it to the user. Each --ask is
its own chat session, saved to memory, so a later one knows it.self_hosted_companion.py exits 1 with a line naming what went
wrong. Run that script from examples/cookbooks/self_hosted_companion/scripts/ on its
own to look closer..env.self_hosted_companion before it ingests (the [clear]
line). On the user's own data, pass --clear only when they asked to start over: it
forgets everything the dataset holds, including the earlier chats.--ui unless the user asked to browse the graph: it keeps running until
Ctrl+C.uv run cognee-cli forget --dataset self_hosted_companion
まだレビューはありません。使ってみた感想をお寄せください。
概要と使いどころ
Use when the user wants to drive cognee from the terminal with cognee-cli — remember/recall/forget/improve memory commands, managing datasets and config, or database migrations.
日本語の概要は準備中です。原文の説明を表示しています。
Use when the user needs something that ships outside cognee core — community database adapters (Qdrant, Milvus, Weaviate, Redis, Pinecone, FalkorDB, Memgraph, DuckDB, NetworkX, …), data-source connectors (Slack, Gmail, Notion, Confluence, Google Drive), custom tasks/pipelines/retrievers (Exa, ScrapeGraph, codify), Keywords AI observability — or wants to contribute a package to the cognee-community repo.
日本語の概要は準備中です。原文の説明を表示しています。
Use when defining the shape of cognee's knowledge graph with graph_model= — writing DataPoint node classes, choosing identity and index fields so nodes merge and are searchable, declaring typed Edge fields and FromIdentity references, building a model from a JSON schema, or debugging duplicated nodes, missing edges, or InvalidReferenceTypeError.
日本語の概要は準備中です。原文の説明を表示しています。
Use when building your own cognee processing — writing custom tasks, chaining them into a pipeline with run_custom_pipeline or the lightweight run_pipeline (from cognee.pipelines import run_pipeline), storing custom DataPoints with add_data_points, running custom extraction/enrichment over the existing graph with memify, checking pipeline run status, or debugging how data flows between tasks (batch_size, data_per_batch, ctx, Drop, enriches).
日本語の概要は準備中です。原文の説明を表示しています。
Use when the user wants to run cognee with Docker or docker compose — trying it out from the prebuilt image, starting the API server in a container, or bringing up the full stack (UI, MCP, Postgres, Neo4j) with compose profiles.
日本語の概要は準備中です。原文の説明を表示しています。
Use when removing data from cognee memory with forget() in the SDK, HTTP API, or CLI — finding which dataset and document hold the content to delete (listing datasets and data items, reading raw content), choosing between deleting one document, a whole dataset, or only the graph/vector memory, and doing it safely.
日本語の概要は準備中です。原文の説明を表示しています。