arki 0.0.4 → 0.0.6

package/README.md

@@ -80,9 +80,25 @@ Ways to enable:
 1. Add `--debug` or `-d` parameter at startup
 2. Type `/debug` during runtime to toggle
 
-## Configuration File
+## Configuration
 
-Configuration file is located at `~/.config/arki/config.json`:
+### Global Configuration
+
+Global configuration is stored in system-specific locations:
+
+- **macOS/Linux**: `~/.config/arki/config.json`
+- **Windows**: `%APPDATA%\arki\config.json`
+
+On first run, Arki copies the default configuration template to this location.
+
+### Project Configuration
+
+Each project can have its own configuration in `.arki/` directory:
+
+- `.arki/config.json` - Project-specific settings (overrides global config)
+- `.arki/state.json` - Project state and cache
+
+On first run in a new project, Arki will ask if you trust the project before initializing the `.arki/` directory.
 
 ### Reset to Factory Defaults
 
@@ -90,7 +106,7 @@ Configuration file is located at `~/.config/arki/config.json`:
 arki --reset
 ```
 
-This will delete the current configuration file. The default configuration will be used on next startup.
+This will delete the global configuration file. The default configuration will be used on next startup.
 
 ## Development
 

package/dist/config/.arki/config.json

@@ -0,0 +1,3 @@
+{
+  "agents": {}
+}

package/dist/config/.arki/state.json

@@ -0,0 +1,4 @@
+{
+  "initialized": true,
+  "createdAt": ""
+}

package/dist/index.d.ts

@@ -113,6 +113,53 @@ declare class Tool {
     run(args: Record<string, unknown>): Promise<ToolResult>;
 }
 
+/**
+ * Procedure class - step-by-step guide for specific workflows
+ */
+declare class Procedure {
+    readonly name: string;
+    readonly description: string;
+    readonly manual: string;
+    constructor(config: {
+        name: string;
+        procedureContent: string;
+    });
+    /**
+     * Parse procedure.md content
+     * First line format: "procedure_name: description", extract description
+     * Remaining content is the procedure steps
+     */
+    static parseManual(content: string): {
+        description: string;
+        manual: string;
+    };
+}
+
+/** OS type definition */
+interface OS_TYPE {
+    /** Operating system name: 'windows' | 'mac' | 'linux' | 'other' */
+    name: 'windows' | 'mac' | 'linux' | 'other';
+    /** Operating system version */
+    version: string;
+}
+/** Global OS information */
+declare const OS: OS_TYPE;
+/** Working directory */
+declare let workingDir: string;
+/** Set working directory (for testing) */
+declare function setWorkingDir(dir: string): void;
+/** Global paths configuration */
+declare const PATHS: {
+    /** Global config directory (~/.config/arki or %APPDATA%\arki) */
+    globalConfig: string;
+    /** Project config directory (.arki/) - returns path based on current workingDir */
+    readonly projectConfig: string;
+    /** Package's global config template directory */
+    globalTemplate: string;
+    /** Package's project config template directory */
+    projectTemplate: string;
+};
+
 /**
  * Fixed parameters
  */
@@ -161,6 +208,17 @@ declare abstract class Adapter {
     getModel(): string;
 }
 
+/** Global tool registry */
+declare const TOOLS: Record<string, Tool>;
+/** Global procedure registry */
+declare const PROCEDURES: Record<string, Procedure>;
+/** Global Adapter instance */
+declare let adapter: Adapter | null;
+/** Initialize global Adapter */
+declare function initAdapter(): void;
+/** Initialize global state */
+declare function init(cwd?: string): Promise<void>;
+
 /**
  * Agent type
  */
@@ -195,62 +253,54 @@ interface GlobalConfig {
     };
 }
 /**
- * Global configuration manager
+ * Get loaded configuration
  */
-declare class ConfigManager {
-    private config;
-    private loaded;
-    /**
-     * Load configuration (called at program startup)
-     */
-    load(): Promise<GlobalConfig>;
-    /**
-     * Save configuration
-     */
-    save(): Promise<void>;
-    get(): GlobalConfig;
-    getApiKey(provider: string): string | undefined;
-    getAgentConfig(agentType: AgentType): AgentModelConfig;
-    private loadEnvApiKeys;
-}
-declare const config: ConfigManager;
-
-/** Working directory */
-declare let workingDir: string;
-/** Set working directory (for testing) */
-declare function setWorkingDir(dir: string): void;
-/** Global tool registry */
-declare const TOOLS: Record<string, Tool>;
-/** Global Adapter instance */
-declare let adapter: Adapter | null;
-/** Initialize global state */
-declare function init(cwd?: string): Promise<void>;
+declare function getConfig(): GlobalConfig;
+/**
+ * Get API key for a provider
+ */
+declare function getApiKey(provider: string): string | undefined;
+/**
+ * Get agent configuration
+ */
+declare function getAgentConfig(agentType: AgentType): AgentModelConfig;
+/**
+ * Save configuration to global config file
+ */
+declare function saveConfig(): Promise<void>;
 
 /**
  * Debug logging module
+ * All debug output is single-line for log-friendly format
  */
 /** Get debug mode status */
 declare function isDebugMode(): boolean;
 /** Set debug mode */
 declare function setDebugMode(enabled: boolean): void;
 /**
- * Debug log function
+ * Debug log function - single line output with timestamp
  * @param category Log category (e.g., 'API', 'Agent', 'Tool')
  * @param message Log message
- * @param data Optional additional data
+ * @param data Optional additional data (will be formatted to single line)
  */
 declare function debug(category: string, message: string, data?: unknown): void;
 
 /**
  * General logging module
+ * All log output is single-line with timestamp prefix
+ * Supports XML-style color tags: <red>text</red>, <bold>text</bold>, etc.
  */
-
 /**
- * Colored log output
- * @param color Color name
- * @param args Content to output
+ * Print output without timestamp (for prompts and simple messages)
+ * @param message Message string with optional XML color tags
+ */
+declare function print(message: string): void;
+/**
+ * Log output with timestamp and XML color tag support
+ * @param message Message string with optional XML color tags
+ * @example log('<yellow>[TOOL]</yellow> read_file <dim>{"path":"test.txt"}</dim>')
  */
-declare function log(color: ColorName, ...args: unknown[]): void;
+declare function log(message: string): void;
 /**
  * Info log
  */
@@ -271,6 +321,7 @@ declare function error(message: string): void;
 /**
  * Logging module
  * Provides debug mode and logging functionality
+ * Supports XML-style color tags: <red>text</red>, <bold>text</bold>, etc.
  */
 /**
  * Terminal colors and style definitions
@@ -293,6 +344,16 @@ declare const colors: {
 };
 /** Color name type */
 type ColorName = keyof typeof colors;
+/**
+ * Convert XML-style color tags to ANSI escape sequences
+ * Example: "<red>error</red>" -> "\x1b[31merror\x1b[0m"
+ */
+declare function convertColorTags(str: string): string;
+/**
+ * Create a buffered streaming color converter
+ * Used for streaming output where tags may span multiple chunks
+ */
+declare function createColorConverter(): (chunk: string) => string;
 
 declare class OpenAIAdapter extends Adapter {
     private client;
@@ -367,4 +428,4 @@ interface Model {
     readonly capabilities: ModelCapabilities;
 }
 
-export { AIMsg, Adapter, type AdapterResponse, Agent, type AgentResponse, type ColorName, HAS_MANUAL, MAX_COMPLETION_TOKENS, MODELS, type Model, type ModelCapabilities, type ModelProvider, Msg, MsgType, OpenAIAdapter, type ReasoningEffort$1 as ReasoningEffort, SystemMsg, TEMPERATURE, TOOLS, Tool, type ToolCall, ToolCallMsg, type ToolResult, ToolResultMsg, UserMsg, adapter, colors, config, debug, error, info, init, isDebugMode, log, setDebugMode, setWorkingDir, success, warn, workingDir };
+export { AIMsg, Adapter, type AdapterResponse, Agent, type AgentModelConfig, type AgentResponse, type AgentType, type ColorName, type GlobalConfig, HAS_MANUAL, MAX_COMPLETION_TOKENS, MODELS, type Model, type ModelCapabilities, type ModelProvider, Msg, MsgType, OS, type OS_TYPE, OpenAIAdapter, PATHS, PROCEDURES, type ReasoningEffort$1 as ReasoningEffort, SystemMsg, TEMPERATURE, TOOLS, Tool, type ToolCall, ToolCallMsg, type ToolResult, ToolResultMsg, UserMsg, adapter, colors, convertColorTags, createColorConverter, debug, error, getAgentConfig, getApiKey, getConfig, info, init, initAdapter, isDebugMode, log, print, saveConfig, setDebugMode, setWorkingDir, success, warn, workingDir };