byterover-cli 0.4.0 → 1.0.0

package/dist/infra/cipher/tools/implementations/find-knowledge-topics-tool.js

@@ -1,424 +0,0 @@
-import { join } from 'node:path';
-import { z } from 'zod';
-import { BRV_DIR, CONTEXT_FILE, CONTEXT_TREE_DIR } from '../../../../constants.js';
-import { ToolName } from '../../../../core/domain/cipher/tools/constants.js';
-import { DirectoryManager } from '../../../../core/domain/knowledge/directory-manager.js';
-import { parseRelations } from '../../../../core/domain/knowledge/relation-parser.js';
-/**
- * Input schema for finding knowledge topics.
- * Supports pattern matching, scoping, depth control, and pagination.
- */
-const FindKnowledgeTopicsInputSchema = z.object({
-    basePath: z
-        .string()
-        .default(`${BRV_DIR}/${CONTEXT_TREE_DIR}`)
-        .describe('Base path to context tree structure'),
-    // Scoping
-    domain: z
-        .string()
-        .optional()
-        .describe('Restrict search to specific domain (exact match)'),
-    // Search filters (substring matching)
-    domainPattern: z
-        .string()
-        .optional()
-        .describe('Domain name pattern for substring matching'),
-    // Relation traversal
-    followRelations: z
-        .boolean()
-        .default(false)
-        .describe('Automatically fetch related topics referenced in Relations section'),
-    includeContent: z
-        .boolean()
-        .default(false)
-        .describe('Include content preview from context.md files'),
-    // Depth control
-    includeSubtopics: z
-        .boolean()
-        .default(false)
-        .describe('Include subtopic details in results'),
-    // Pagination
-    limit: z
-        .number()
-        .int()
-        .positive()
-        .optional()
-        .describe('Maximum number of results to return'),
-    offset: z
-        .number()
-        .int()
-        .nonnegative()
-        .default(0)
-        .describe('Number of results to skip'),
-    relationDepth: z
-        .number()
-        .int()
-        .positive()
-        .default(1)
-        .describe('How many levels deep to follow relations (default: 1, max: 3)'),
-    subtopicPattern: z
-        .string()
-        .optional()
-        .describe('Subtopic name pattern for substring matching'),
-    topicPattern: z
-        .string()
-        .optional()
-        .describe('Topic name pattern for substring matching'),
-});
-/**
- * Read content preview from a file, truncating to 500 characters if needed.
- */
-async function readContentPreview(filePath) {
-    try {
-        const content = await DirectoryManager.readFile(filePath);
-        return content.length > 500 ? content.slice(0, 500) + '...' : content;
-    }
-    catch {
-        return '[Content unavailable]';
-    }
-}
-/**
- * Read and parse relations from a context.md file.
- */
-async function readRelations(filePath) {
-    try {
-        const content = await DirectoryManager.readFile(filePath);
-        return parseRelations(content);
-    }
-    catch {
-        return [];
-    }
-}
-/**
- * Process a single subtopic file and return its entry.
- */
-async function processSubtopicFile(params) {
-    const { domainName, includeContent, subtopicFile, subtopicPattern, topicName, topicPath } = params;
-    const subtopicRelativePath = subtopicFile.replace(topicPath, '').replace(/^\//, '');
-    const subtopicParts = subtopicRelativePath.split('/');
-    // Check if this is a subtopic context.md (not the topic's own context.md)
-    if (subtopicParts.length <= 1 || subtopicParts.at(-1) !== CONTEXT_FILE) {
-        return null;
-    }
-    const subtopicName = subtopicParts[0];
-    // Apply subtopic pattern filter if specified (case-insensitive)
-    if (subtopicPattern && !subtopicName.toLowerCase().includes(subtopicPattern.toLowerCase())) {
-        return null;
-    }
-    const subtopicEntry = {
-        name: subtopicName,
-        path: `${BRV_DIR}/${CONTEXT_TREE_DIR}/${domainName}/${topicName}/${subtopicName}/${CONTEXT_FILE}` // Full path
-    };
-    // Include subtopic content preview if requested
-    if (includeContent) {
-        subtopicEntry.contentPreview = await readContentPreview(subtopicFile);
-    }
-    // Always parse relations to enable relation traversal
-    const relations = await readRelations(subtopicFile);
-    if (relations.length > 0) {
-        subtopicEntry.relations = relations;
-    }
-    return subtopicEntry;
-}
-/**
- * Collect all subtopics for a given topic.
- */
-async function collectSubtopics(params) {
-    const { basePath, domainName, includeContent, subtopicPattern, topicName } = params;
-    const topicPath = join(basePath, domainName, topicName);
-    const subtopicFiles = await DirectoryManager.listMarkdownFiles(topicPath);
-    const subtopics = [];
-    for (const subtopicFile of subtopicFiles) {
-        // eslint-disable-next-line no-await-in-loop
-        const subtopicEntry = await processSubtopicFile({
-            domainName,
-            includeContent,
-            subtopicFile,
-            subtopicPattern,
-            topicName,
-            topicPath,
-        });
-        if (subtopicEntry) {
-            subtopics.push(subtopicEntry);
-        }
-    }
-    return subtopics;
-}
-/**
- * Check if a topic matches the filter criteria.
- */
-function matchesFilters(params) {
-    const { domain, domainName, domainPattern, topicName, topicPattern } = params;
-    // Normalize all strings to lowercase for case-insensitive matching
-    const normalizedDomainName = domainName.toLowerCase();
-    const normalizedTopicName = topicName.toLowerCase();
-    // Apply domain scoping filter (exact match, case-insensitive)
-    if (domain && normalizedDomainName !== domain.toLowerCase())
-        return false;
-    // Apply pattern filters (substring matching, case-insensitive)
-    if (domainPattern && !normalizedDomainName.includes(domainPattern.toLowerCase()))
-        return false;
-    if (topicPattern && !normalizedTopicName.includes(topicPattern.toLowerCase()))
-        return false;
-    return true;
-}
-/**
- * Collect relations from subtopics.
- */
-function collectSubtopicRelations(subtopics) {
-    const relations = [];
-    for (const subtopic of subtopics) {
-        if (subtopic.relations) {
-            relations.push(...subtopic.relations);
-        }
-    }
-    return relations;
-}
-/**
- * Collect all relation paths from a set of results.
- */
-function collectAllRelations(results) {
-    const allRelations = new Set();
-    for (const result of results) {
-        if (result.relations) {
-            for (const rel of result.relations)
-                allRelations.add(rel);
-        }
-        if (result.subtopics) {
-            const subtopicRelations = collectSubtopicRelations(result.subtopics);
-            for (const rel of subtopicRelations)
-                allRelations.add(rel);
-        }
-    }
-    return allRelations;
-}
-/**
- * Fetch related topics by following relation references.
- * Recursively traverses relations up to the specified depth.
- */
-async function fetchRelatedTopics(params) {
-    const { basePath, currentDepth, includeContent, maxDepth, relationPaths, seenPaths } = params;
-    if (currentDepth > maxDepth || relationPaths.length === 0) {
-        return [];
-    }
-    const relatedTopics = [];
-    for (const relationPath of relationPaths) {
-        // Avoid circular references
-        if (seenPaths.has(relationPath))
-            continue;
-        seenPaths.add(relationPath);
-        const parts = relationPath.split('/');
-        if (parts.length < 2 || parts.length > 3)
-            continue;
-        const [domainName, topicName] = parts;
-        const contextPath = join(basePath, ...parts, CONTEXT_FILE);
-        try {
-            // eslint-disable-next-line no-await-in-loop
-            const fileExists = await DirectoryManager.fileExists(contextPath);
-            if (!fileExists)
-                continue;
-            const entry = {
-                domain: domainName,
-                path: `${basePath}/${relationPath}/${CONTEXT_FILE}`,
-                topic: topicName,
-            };
-            // Include content preview if requested
-            if (includeContent) {
-                // eslint-disable-next-line no-await-in-loop
-                entry.contentPreview = await readContentPreview(contextPath);
-            }
-            // Parse relations from this topic
-            // eslint-disable-next-line no-await-in-loop
-            const nestedRelations = await readRelations(contextPath);
-            if (nestedRelations.length > 0) {
-                entry.relations = nestedRelations;
-                // Recursively fetch nested relations if depth allows
-                if (currentDepth < maxDepth) {
-                    // eslint-disable-next-line no-await-in-loop
-                    const nestedTopics = await fetchRelatedTopics({
-                        basePath,
-                        currentDepth: currentDepth + 1,
-                        includeContent,
-                        maxDepth,
-                        relationPaths: nestedRelations,
-                        seenPaths,
-                    });
-                    relatedTopics.push(...nestedTopics);
-                }
-            }
-            relatedTopics.push(entry);
-        }
-        catch {
-            // Skip missing or invalid relations
-            continue;
-        }
-    }
-    return relatedTopics;
-}
-/**
- * Execute the find knowledge topics operation.
- * Searches the context tree structure and applies filters.
- *
- * @param input - Validated input parameters
- * @param _context - Tool execution context (unused)
- * @returns Structured results with total count and paginated data
- */
-async function executeFindKnowledgeTopics(input, _context) {
-    const { basePath, domain, domainPattern, followRelations, includeContent, includeSubtopics, limit, offset, relationDepth, subtopicPattern, topicPattern, } = input;
-    const results = [];
-    const seenTopics = new Set(); // Track unique topic paths to avoid duplicates
-    try {
-        // List all markdown files in the context tree
-        const mdFiles = await DirectoryManager.listMarkdownFiles(basePath);
-        // Process each markdown file
-        for (const filePath of mdFiles) {
-            // Extract relative path from base
-            const relativePath = filePath.replace(basePath, '').replace(/^\//, '');
-            const parts = relativePath.split('/');
-            // Context tree structure: domain/topic/context.md or domain/topic/subtopic/context.md
-            if (parts.length < 2)
-                continue; // Need at least domain/file
-            const [domainName, topicName, ...rest] = parts;
-            const isSubtopic = rest.length > 1; // Has subtopic folder
-            // Skip if not a context.md file (only process context files)
-            const fileName = parts.at(-1);
-            if (fileName !== CONTEXT_FILE)
-                continue;
-            if (parts.length === 2)
-                continue; // Skip domain context.md files because they don't have much info
-            // Handle subtopic pattern filtering (case-insensitive)
-            if (isSubtopic) {
-                const subtopicName = rest[0];
-                if (subtopicPattern && !subtopicName.toLowerCase().includes(subtopicPattern.toLowerCase()))
-                    continue;
-                // Skip subtopics for now - we'll collect them when processing their parent topic
-                continue;
-            }
-            // Apply filters
-            if (!matchesFilters({
-                domain,
-                domainName,
-                domainPattern,
-                topicName,
-                topicPattern,
-            })) {
-                continue;
-            }
-            // Create unique key for this topic to avoid duplicates
-            const topicKey = `${domainName}/${topicName}`;
-            if (seenTopics.has(topicKey))
-                continue;
-            seenTopics.add(topicKey);
-            // Build result entry for this topic
-            const entry = {
-                domain: domainName,
-                path: `${basePath}/${domainName}/${topicName}/${CONTEXT_FILE}`,
-                topic: topicName,
-            };
-            // Include content preview if requested
-            if (includeContent) {
-                // eslint-disable-next-line no-await-in-loop
-                entry.contentPreview = await readContentPreview(filePath);
-            }
-            // Always parse relations to enable relation traversal
-            // eslint-disable-next-line no-await-in-loop
-            const topicRelations = await readRelations(filePath);
-            if (topicRelations.length > 0) {
-                entry.relations = topicRelations;
-            }
-            // Include subtopics if requested
-            if (includeSubtopics) {
-                // eslint-disable-next-line no-await-in-loop
-                const subtopics = await collectSubtopics({
-                    basePath,
-                    domainName,
-                    includeContent,
-                    subtopicPattern,
-                    topicName,
-                });
-                if (subtopics.length > 0) {
-                    entry.subtopics = subtopics;
-                }
-            }
-            results.push(entry);
-        }
-        // Apply pagination
-        const total = results.length;
-        const effectiveOffset = offset ?? 0;
-        const paginatedResults = limit
-            ? results.slice(effectiveOffset, effectiveOffset + limit)
-            : results.slice(effectiveOffset);
-        // Follow relations if requested
-        if (followRelations && paginatedResults.length > 0) {
-            const maxDepth = Math.min(relationDepth ?? 1, 3); // Cap at 3 to prevent excessive traversal
-            const allRelations = collectAllRelations(paginatedResults);
-            // Fetch related topics recursively
-            if (allRelations.size > 0) {
-                const relatedTopics = await fetchRelatedTopics({
-                    basePath,
-                    currentDepth: 1,
-                    includeContent,
-                    maxDepth,
-                    relationPaths: [...allRelations],
-                    seenPaths: seenTopics, // Reuse seenTopics to avoid duplicates
-                });
-                // Append related topics to results
-                paginatedResults.push(...relatedTopics);
-            }
-        }
-        return {
-            results: paginatedResults,
-            total,
-        };
-    }
-    catch {
-        // If base path doesn't exist or other errors, return empty results
-        return {
-            results: [],
-            total: 0,
-        };
-    }
-}
-/**
- * Factory function to create the find knowledge topics tool.
- *
- * @returns Configured Tool instance
- */
-export function createFindKnowledgeTopicsTool() {
-    return {
-        description: `Search and filter knowledge topics in the context tree structure with relation support.
-
-This tool helps discover what knowledge has been stored and navigate the domain/topic hierarchy. It works similarly to find_symbol but for knowledge organization, with the ability to follow relations between topics.
-
-**Use cases:**
-- Discover what knowledge topics exist in a domain
-- Find topics matching specific patterns
-- Navigate the knowledge hierarchy via relations
-- Retrieve context for specific areas
-- Check what has been documented
-- Follow related topics for comprehensive context
-
-**Search capabilities:**
-- Pattern matching on domain, topic, and subtopic names (substring matching)
-- Scope searches to specific domains (exact match)
-- Optional subtopic inclusion (depth control)
-- Optional content preview (500 character limit)
-- Pagination for large result sets
-- Relation traversal (automatically fetch related topics up to 3 levels deep)
-
-**Examples:**
-- Find all topics in "testing" domain: {domain: "testing"}
-- Find topics about "eslint": {topicPattern: "eslint"}
-- Find subtopics with "config": {subtopicPattern: "config", includeSubtopics: true}
-- Get content previews: {domain: "architecture", includeContent: true}
-- Follow relations: {topicPattern: "auth", followRelations: true, relationDepth: 2}
-- Paginate results: {limit: 10, offset: 0}
-
-**Returns:**
-- total: Total number of matching topics (before relation traversal)
-- results: Array of topic entries with domain, topic name, optional relations, subtopics, and content with complete paths`,
-        execute: executeFindKnowledgeTopics,
-        id: ToolName.FIND_KNOWLEDGE_TOPICS,
-        inputSchema: FindKnowledgeTopicsInputSchema,
-    };
-}

package/dist/resources/prompts/modes/autonomous.yml

@@ -1,9 +0,0 @@
-description: "autonomous execution instructions"
-prompt: |
-
-  CRITICAL: Autonomous Execution Required
-
-  You are currently in autonomous mode. You can use all tools to process the input data and perform the CREATE, READ, UPDATE and DELETE operations on the context tree without any human intervention.
-
-excluded_tools: []
-

package/dist/resources/prompts/query-context-tree-retrieval.yml

@@ -1,48 +0,0 @@
-description: "context tree retrieval instructions for query command"
-prompt: |
-
-  Your task is to search and retrieve relevant information from the context tree to answer the user's query. 
-  Prioritize tool call efficiency for tools that can be run in parallel.
-  ONLY give up on search in the last iteration.
-
-  Follow these steps to provide comprehensive answers:
-
-  1. **Understand the query**: Analyze what the user is asking for - which domains, topics, or specific information they need.
-
-  2. **Search strategically**:
-     - Use `find_knowledge_topics` to locate relevant topics across domains with pattern matching. Use the 'path' field for `read_file` tool if you need full content.
-     - Use `read_file` to read the full content of relevant context.md files
-     - Use `grep_content` to search for specific terms, code snippets, or patterns within context files
-     - Use `glob_files` to find files by path patterns if needed
-     - For multi-part queries (queries that include words like "and"), use tools in parallel:
-      - Use `find_knowledge_topics` and `read_file` multiple times to get all relevant topics and their full content.
-      - If ANY of these tools don't depend on each other, try to run them in the same iteration.
-     - Consider the context tree structure: `.brv/context-tree/{domain}/{topic}/context.md` or `.brv/context-tree/{domain}/{topic}/{subtopic}/context.md`
-
-  3. **Read relevant content**:
-     - Use `read_file` to read the full content of relevant context.md files
-     - Read multiple files if the query spans multiple domains or topics
-
-  4. **Synthesize and present**:
-     - Organize findings by domain and topic
-     - Important: Even if you don't have the answer, provide the best answer you can with the information gathered.
-     - Include relevant content excerpts with their source paths (e.g., "From code_style/best_practices:")
-     - Provide clear, structured answers with citations. 
-     - If multiple topics are relevant, group them logically
-
-  5. **Be thorough but efficient**:
-     - Search progressively - start broad, then narrow down based on findings
-     - Use pattern matching to avoid reading entire tree
-     - If initial search returns too many results, refine with more specific patterns
-     - If search returns no results, try broader patterns or alternative terms
-
-  Default domains in the context tree (search in .brv/context-tree if users add new domains):
-  - `code_style` - Coding standards, style guidelines, quality standards
-  - `design` - UI/UX design, component libraries, themes, design systems
-  - `structure` - Project structure, architecture, component organization
-  - `compliance` - Security policies, compliance requirements, best practices
-  - `testing` - Testing strategies, test implementation, quality assurance
-  - `bug_fixes` - Bug fixing procedures, common issues, troubleshooting guides
-
-excluded_tools: []
-

package/dist/tui/contexts/consumer.d.ts

@@ -1,31 +0,0 @@
-/**
- * Consumer Context
- *
- * Global context for managing consumer service and queue polling state.
- * Consolidates useConsumer and useQueuePolling hooks into a single context.
- *
- * Usage:
- * ```tsx
- * const { consumerId, sessionExecutions, stats } = useConsumer()
- * ```
- */
-import React from 'react';
-import type { ExecutionWithToolCalls, QueueStats } from '../../infra/cipher/consumer/queue-polling-service.js';
-import type { ConsumerStatus } from '../types.js';
-interface ConsumerContextValue {
-    consumerError: Error | null;
-    consumerId: null | string;
-    consumerStatus: ConsumerStatus;
-    isConnected: boolean;
-    pollingError: Error | null;
-    reconnectCount: number;
-    restart: () => Promise<void>;
-    sessionExecutions: ExecutionWithToolCalls[];
-    stats: null | QueueStats;
-}
-interface ConsumerProviderProps {
-    children: React.ReactNode;
-}
-export declare function ConsumerProvider({ children }: ConsumerProviderProps): React.ReactElement;
-export declare function useConsumer(): ConsumerContextValue;
-export {};

package/dist/tui/contexts/consumer.js

@@ -1,56 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-/**
- * Consumer Context
- *
- * Global context for managing consumer service and queue polling state.
- * Consolidates useConsumer and useQueuePolling hooks into a single context.
- *
- * Usage:
- * ```tsx
- * const { consumerId, sessionExecutions, stats } = useConsumer()
- * ```
- */
-import { createContext, useContext, useMemo } from 'react';
-import { useConsumer as useConsumerHook } from '../hooks/use-consumer.js';
-import { useQueuePolling } from '../hooks/use-queue-polling.js';
-const ConsumerContext = createContext(undefined);
-export function ConsumerProvider({ children }) {
-    // Start consumer service
-    const { consumerError, consumerId, consumerStatus, restart } = useConsumerHook();
-    // Poll queue for executions and stats
-    const { error: pollingError, isConnected, reconnectCount, sessionExecutions, stats, } = useQueuePolling({
-        consumerId: consumerId ?? undefined,
-        pollInterval: 1000,
-    });
-    const contextValue = useMemo(() => ({
-        // Consumer state
-        consumerError,
-        consumerId,
-        consumerStatus,
-        // Queue polling state
-        isConnected,
-        pollingError,
-        reconnectCount,
-        restart,
-        sessionExecutions,
-        stats,
-    }), [
-        consumerError,
-        consumerId,
-        consumerStatus,
-        restart,
-        isConnected,
-        pollingError,
-        reconnectCount,
-        sessionExecutions,
-        stats,
-    ]);
-    return _jsx(ConsumerContext.Provider, { value: contextValue, children: children });
-}
-export function useConsumer() {
-    const context = useContext(ConsumerContext);
-    if (!context) {
-        throw new Error('useConsumer must be used within ConsumerProvider');
-    }
-    return context;
-}

package/dist/tui/hooks/use-consumer.d.ts

@@ -1,12 +0,0 @@
-/**
- * Consumer Hook
- *
- * Hook to manage consumer lifecycle
- */
-import type { ConsumerStatus } from '../types.js';
-export declare function useConsumer(): {
-    consumerError: Error | null;
-    consumerId: null | string;
-    consumerStatus: ConsumerStatus;
-    restart: () => Promise<void>;
-};

package/dist/tui/hooks/use-consumer.js

@@ -1,50 +0,0 @@
-/**
- * Consumer Hook
- *
- * Hook to manage consumer lifecycle
- */
-import { useCallback, useEffect, useRef, useState } from 'react';
-import { ConsumerService } from '../../infra/cipher/consumer/consumer-service.js';
-export function useConsumer() {
-    const [status, setStatus] = useState('starting');
-    const [consumerError, setConsumerError] = useState(null);
-    const [consumerId, setConsumerId] = useState(null);
-    const consumerRef = useRef(new ConsumerService());
-    const mountedRef = useRef(true);
-    const startConsumer = useCallback(async () => {
-        try {
-            setStatus('starting');
-            setConsumerError(null);
-            await consumerRef.current.start();
-            if (mountedRef.current) {
-                setStatus('running');
-                setConsumerId(consumerRef.current.getConsumerId());
-            }
-        }
-        catch (error) {
-            if (mountedRef.current) {
-                setStatus('error');
-                setConsumerError(error instanceof Error ? error : new Error(String(error)));
-            }
-        }
-    }, []);
-    const restart = useCallback(async () => {
-        // Dispose current consumer
-        consumerRef.current.dispose();
-        setStatus('stopped');
-        setConsumerId(null);
-        // Create new consumer and start
-        consumerRef.current = new ConsumerService();
-        await startConsumer();
-    }, [startConsumer]);
-    useEffect(() => {
-        mountedRef.current = true;
-        startConsumer();
-        return () => {
-            mountedRef.current = false;
-            consumerRef.current.dispose();
-            setStatus('stopped');
-        };
-    }, [startConsumer]);
-    return { consumerError, consumerId, consumerStatus: status, restart };
-}

package/dist/tui/hooks/use-queue-polling.d.ts

@@ -1,31 +0,0 @@
-/**
- * Queue Polling Hook
- *
- * React hook for subscribing to QueuePollingService events
- *
- * Architecture:
- * - Connects to singleton QueuePollingService
- * - Updates React state only when data changes
- * - Cleans up on unmount
- * - Prevents memory leaks via singleton pattern
- *
- * Usage in Ink component:
- * ```tsx
- * const { stats, sessionExecutions, error } = useQueuePolling({ consumerId })
- * ```
- */
-import type { ExecutionWithToolCalls, QueueStats } from '../../infra/cipher/consumer/queue-polling-service.js';
-export declare function useQueuePolling(options?: {
-    consumerId?: string;
-    pollInterval?: number;
-}): {
-    error: Error | null;
-    isConnected: boolean;
-    reconnectCount: number;
-    sessionExecutions: ExecutionWithToolCalls[];
-    stats: null | QueueStats;
-};
-/**
- * Cleanup hook - call when dashboard unmounts
- */
-export declare function useQueuePollingCleanup(): () => void;