@j-o-r/hello-dave 0.0.2 → 0.0.3

package/examples/grok_note_keeping.js

@@ -1,111 +0,0 @@
-#!/usr/bin/env node
-import { fileURLToPath } from 'url';
-import path from 'path';
-import AgentManager from '../lib/AgentManager.js';
-import { systemInfo } from '../lib/fafs.js';
-import { parseArgs, readIn } from '@j-o-r/sh';
-import toolsPool from '../lib/genericToolset.js';
-
-const name = path.basename(fileURLToPath(import.meta.url), path.extname(fileURLToPath(import.meta.url)));
-const api = 'grok';  // Using GPT API for general AI assistance, adjust if needed
-
-const input = await readIn();
-const args = parseArgs();
-const help = args['help'] || false;
-const connect = args['connect'] ? args['connect'] : undefined;
-const serve = args['serve'] ? parseInt(args['serve']) : undefined;
-
-/** @type {import('../lib/API/x.ai/text.js').XOptions} */  // Assuming GPT uses OpenAI API
-const options = {}
-// Set properties only if provided via command line
-if (args['model'] || true) {
-    // @ts-ignore
-    options.model = args['model'] || 'grok-4'; 
-}
-if (args['temperature']) {
-    options.temperature = parseFloat(args['temperature']);
-}
-if (args['tokens']) {
-    options.max_completion_tokens = parseInt(args['tokens']);
-}
-if (args['top_p']) {
-    options.top_p = parseFloat(args['top_p']);
-}
-
-options.search_parameters = {mode:'auto'}
-
-const reasoning = args['reasoning'] ? args['reasoning'] : null;
-if (reasoning) {
-    // @ts-ignore
-    options.reasoning_effort = reasoning
-}
-
-const toolsetMode = 'auto';
-const contextWindow = args['context'] ? parseInt(args['context']) : 250000;
-
-// Copy from the generic toolset
-function printHelp() {
-    console.log(`
-'${name} --help' You are looking at it.
-
-OPTIONS: 
---tokens [number]: max generated tokens 
---context [number] : truncate message history to context-windows size default 250000
---temperature [float] : -2 / +2
---model [gpt-4o|gpt-4o-mini|etc]  // Adjust based on available models
---top_p [float]: number > 0, 0.1 means no top_p
---reasoning [low|high]
---tools [javascript,bash] comma separated list
-e.g.
-note_keeping.js --model gpt-4o-mini --tokens 4000 --context 10000
-
-`);
-    process.exit()
-}
-
-if (help) {
-    printHelp();
-}
-const sys = await systemInfo();
-const prompt = `
-You are an AI note-keeping assistant for Markdown notes in extended context. Use/create 'notes' folder in cwd. Search via tools like grep. Create/update/delete .md files safely. Goals: track progress, manage todos, capture requirements, document processes, store links/bookmarks/remarks. Respond concisely, step-by-step, no unnecessary follow-ups.
----env
-${sys}
----
-`.trim();
-const agent = new AgentManager({ name });
-agent.setup({
-    prompt,
-    api,
-    options,
-    toolsetMode,
-    contextWindow
-});
-const toolset = agent.getToolset();
-
-if (toolset) {
-  let tool  = toolsPool.get('execute_bash_script');
-  if (tool) {
-  	toolset.add('execute_bash_script', tool.description, tool.parameters, tool.method);
-  }
-}
-const cliIntro = `
-${options.model}.
-- search  ${options.search_parameters.mode}
-`.trim();
-const description = `
-AI-assisted note-keeping tool for managing Markdown notes, including search, creation, updates, and deletion. Supports progress tracking, todos, requirements, docs, links, bookmarks, and remarks.
-`.trim();
-
-if (input === '' && serve) {
-    agent.enableServer('memory', description, serve);
-}
-if (input !== '') {
-    // Direct input output
-    const res = await agent.directCall(input);
-    console.log(res);
-} else if(connect) {
-    agent.attach('memory', description, connect)
-} else {
-    agent.startCli(cliIntro);
-}

package/module.md

@@ -1,189 +0,0 @@
-# @j-o-r/hello-dave Module Documentation
-
-## Overview
-**Name:** @j-o-r/hello-dave  
-**Version:** 0.0.0  
-**Description:** API to various endpoints mainly focused on AI  
-
-This is a small, ESM-only Node.js toolkit for building AI "agents" with:
-- One unified Prompt abstraction across multiple LLM providers (x.ai Grok, OpenAI, Anthropic)
-- First-class function calling via a simple ToolSet
-- A tiny AgentManager that wires everything together (CLI, direct calls, WS server/client)
-- Optional persisted sessions and records on disk
-
-Key features include:
-- Support for multiple AI providers: x.ai (Grok), OpenAI, Anthropic
-- ToolSet for function calling with JSON schema
-- AgentManager for easy integration
-- CLI tools for interactive use
-- WebSocket-based agent servers and clients for distributed setups
-- Session persistence under ./.cache/hello-dave/<agent-name>/
-- Built-in tools like JavaScript interpreter and bash execution
-
-Note: This is a personal project, created for convenience and exclusively used and tested on Debian/Ubuntu. It can be used to create, use and combine Agents. It has great potential and is very powerful; e.g., `hdCode` has full access to the user environment and is able to execute any command or code. Prompt injection is a risk so use with care.
-
-## Installation Notes
-The module is already installed in the current working directory. For manual installation in your project:
-```bash
-npm install @j-o-r/hello-dave
-```
-
-Requirements:
-- Node.js >= 20 (ESM only)
-- API keys via environment variables (set only what you use):
-  - XAIKEY for x.ai (Grok)
-  - OPENAIKEY for OpenAI
-  - ANTHKEY for Anthropic
-  - BRAVESEARCHKEY for Brave Search tool (optional)
-
-After installation, use either the programmatic API (AgentManager) or the provided CLIs.
-
-For development from repo:
-- npm install
-- export keys
-- node examples/grok.js  # or add ./bin to PATH
-
-## API Usage Examples
-
-### Minimal Direct Call
-```js
-import AgentManager from '@j-o-r/hello-dave';
-
-const agent = new AgentManager({ name: 'grok' });
-agent.setup({
-  prompt: 'Be precise and concise.',
-  api: 'grok',
-  options: {
-    model: 'grok-4',
-    search_parameters: { mode: 'auto' }
-  },
-  toolsetMode: 'auto',
-  contextWindow: 250_000
-});
-
-const answer = await agent.directCall('Two bullet points on tail recursion.');
-console.log(answer);
-```
-
-### Adding Custom Tools
-```js
-const toolset = agent.getToolset();
-if (toolset) {
-  toolset.add(
-    'say_hello',
-    'Return a friendly greeting',
-    {
-      type: 'object',
-      properties: { name: { type: 'string', description: 'Who to greet' } },
-      required: ['name']
-    },
-    async ({ name }) => `Hello, ${name}!`
-  );
-}
-```
-
-### Running as Tool Server
-```js
-agent.enableServer('search', 'General-purpose search interface', 8000);
-// WS on ws://127.0.0.1:8000/ws; connected clients become callable tools.
-```
-
-### Attaching as WS Client
-```js
-agent.attach(
-  'code',
-  'Run JavaScript snippets safely and return output',
-  'ws://127.0.0.1:8000/ws'
-);
-```
-
-### CLI Example (from examples/grok.js)
-- Interactive: node examples/grok.js
-- One-shot: echo "question" | node examples/grok.js
-- With tools: node examples/grok.js --tools javascript,bash
-- Server: node examples/grok.js --serve 8000 --tools javascript,bash
-- Client: node examples/grok.js --connect ws://127.0.0.1:8000/ws
-
-### Utils
-```bash
-npx hdClear  # Clear sessions and logs
-npx hdInspect [file.ndjson]  # Read ndjson files
-npx hdPrompt  # Design prompts (needs x.ai key)
-npx hdAsk  # Ask generic question to GPT (needs OpenAI key)
-npx hdConnect [ws://url]  # Connect to WS agent server
-```
-
-## Full API Reference
-
-### AgentManager (main entry point)
-From types/AgentManager.d.ts
-
-**Constructor:**
-- `new AgentManager(options: Options)`: Create agent with name and optional cachePath.
-
-**Methods:**
-- `setup(setup: Setup): this`: Configure prompt, api, options, etc.
-- `startCli(description: string): void`: Start CLI for local usage.
-- `attach(name: string, description: string, url?: string): AgentClient`: Attach to WS server as client.
-- `enableServer(name: string, description?: string, port?: number): void`: Start WS server on localhost.
-- `directCall(input: string): Promise<string>`: Direct call to the prompt.
-- `getPrompt(): Prompt`: Get the Prompt instance.
-- `getToolset(): ToolSet | void`: Get the ToolSet if enabled.
-- `environment(): Promise<EnvironmentInfo>`: Get environment info.
-- `addGenericToolcall(name: string): void`: Add a generic tool call.
-
-**Types:**
-- `Options`: { name: string, cachePath?: string }
-- `Setup`: { prompt: string, options: OAOptions | XOptions | ANTHOptions, api: 'gpt' | 'grok' | 'claude', contextWindow?: number, toolsetMode?: 'auto' | 'required' | void, debug?: boolean }
-
-### ToolSet
-From types/ToolSet.d.ts
-
-**Constructor:**
-- `new ToolSet(choice?: string)`: 'auto' | 'none' | 'required'
-
-**Properties:**
-- `length: number`: Number of registered functions.
-- `toolChoice: string`
-
-**Methods:**
-- `add(name: string, description: string, parameters: TSSchema, method: (arg0: object) => Promise<any>): void`: Register a tool.
-- `get(name: string): TSTool`: Get a tool.
-- `delete(name: string): void`: Remove a tool.
-- `has(name: string): boolean`: Check if tool exists.
-- `list(): TSToolListItem[]`: List all tools.
-- `call(name: string, params: object): Promise<any>`: Execute a tool.
-- `execute(prompt: Prompt): Promise<void>`: Execute tool calls from prompt.
-
-**Types:**
-- `TSSchema`: { type: string, properties: object, required?: string[] }
-- `TSTool`: { description: string, parameters: TSSchema, method: (arg0: object) => Promise<any> }
-- `TSToolListItem`: { name: string, description: string, parameters: TSSchema }
-
-### Prompt
-From types/Prompt.d.ts (partial, large file)
-
-Handles uniform message format, function-call plumbing, truncation, provider-neutral calls.
-
-### Other Classes
-- `AgentClient`: WS client for processing requests.
-- `AgentServer`: WS server that turns clients into ToolSet functions.
-- `Cli`: TUI with history, shortcuts (uses @j-o-r/cli internally).
-- `Session`: On-disk persistence for sessions, logs, records.
-
-### API Adaptors
-- API/x.ai: For Grok
-- API/openai.com: For GPT
-- API/anthropic.com: For Claude
-- API/brave.com: For search tool
-
-## Dependencies
-- **@j-o-r/apiserver**: ^2.1.5 - For HTTP/WS server functionality (see its module.md for details).
-- **@j-o-r/cli**: * - For CLI interface (interactive TUI with modes, questions, shortcuts).
-- **gpt-3-encoder**: * - For token encoding.
-
-Relevant dependency info:
-- @j-o-r/cli: Interactive CLI framework with mode-based output, command parsing, key mappings, spinners. Used for the built-in CLI tools.
-- @j-o-r/apiserver: Lightweight HTTP/WS server for API controllers, streaming, file serving. Used for WS agent servers.
-
-All dependencies are scoped under @j-o-r, personal modules.