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

package/README.md.backup

@@ -0,0 +1,269 @@
+# @j-o-r/hello-dave
+
+[![npm version](https://badge.fury.io/js/%40j-o-r%2Fhello-dave.svg)](https://www.npmjs.com/package/%40j-o-r%2Fhello-dave)
+[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Node.js >=20](https://img.shields.io/badge/Node.js-%3E=20-green.svg)](https://nodejs.org/)
+
+## Table of Contents
+
+- [Description](#description)
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Usage](#usage)
+- [Examples](#examples)
+- [Development](#development)
+- [Changelog](#changelog)
+- [Contributing](#contributing)
+- [License](#license)
+- [TODO Alignment](#todo-alignment)
+
+## Description
+
+**@j-o-r/hello-dave** is a lightweight, ESM-only Node.js framework for building intelligent AI agents powered by large language models (LLMs) such as xAI Grok, Anthropic Claude, or OpenAI GPT. It simplifies the creation of custom agents with features like the central `AgentManager` class, WebSocket-based client/server support for networked agents, seamless tool integration (e.g., bash execution, web search), customizable system prompts, and robust session management supporting large context windows (up to millions of tokens).
+
+The framework emphasizes ease of use, allowing developers and non-experts alike to rapidly prototype and deploy specialized agents. Core integrations include unified xAI Grok API access, WebSocket (WS) networking with secret-based authentication, and direct CLI/cron messaging (no heartbeat/ping mechanism required). Example scripts like `readmeDave`, `todoDave`, and others have been reorganized into the `examples/` folder for clarity.
+
+Whether you're building a code reviewer, a research assistant, or a creative collaborator, `@j-o-r/hello-dave` abstracts away API complexities, providing a unified interface across providers. It's alpha-stage but production-ready for personal projects, with persistence for sessions and logs in NDJSON format.
+
+## Features
+
+- **Unified LLM Access**: Seamless integration with xAI Grok API, Anthropic Claude, and OpenAI GPT via a single API.
+- **AgentManager Class**: Core orchestrator for prompts, tools, sessions, and interactions (CLI, direct calls, WebSocket).
+- **Tool Integration**: Built-in tools for bash scripting, web search, JavaScript execution, and more; easily extensible.
+- **WebSocket Networking with Secrets**: Agents can act as servers or clients with optional secret authentication, enabling secure distributed agent networks across machines.
+- **Direct CLI/Cron Messaging**: Simplified interactions without needing heartbeat mechanisms—ideal for scheduled tasks.
+- **Customizable Prompts**: Tailor agent behavior with system prompts for specialized tasks (e.g., music production, code analysis).
+- **Session Management**: Persistent conversations with large context windows; automatic truncation and history search.
+- **CLI Utilities**: Core tool at `bin/dave.js` for cache management, WS connections, and interactive queries; plus agent generator.
+- **Lightweight & TypeScript-Friendly**: ESM-only, no heavy deps; full types included.
+
+## Installation
+
+Install as a dependency in your Node.js project (requires Node.js >= 20 with `"type": "module"` in `package.json`):
+
+```bash
+npm install @j-o-r/hello-dave
+```
+
+For global access to CLI tools (including `dave` from `bin/dave.js`):
+
+```bash
+npm install -g @j-o-r/hello-dave
+```
+
+Set your API keys via environment variables (only set what you need):
+- `XAIKEY` for xAI Grok
+- `ANTHKEY` for Anthropic Claude
+- `OPENAIKEY` for OpenAI GPT
+- `BRAVESEARCHKEY` for web search (optional)
+
+Create a cache directory for sessions:
+```bash
+mkdir .cache
+```
+
+## Quick Start
+
+1. Set an API key (e.g., for Grok):
+   ```bash
+   export XAIKEY=your_xai_api_key
+   ```
+
+2. Use the core CLI utility `bin/dave.js` for interactive queries or management:
+   ```bash
+   npx @j-o-r/hello-dave dave --ask
+   ```
+   - Launches an interactive agent session. Use `Alt+d` to exit, `Alt+r` to reset.
+   - Example: Ask questions about anything; it uses xAI Grok by default with web search and X search tools.
+
+3. For one-shot queries via piped input:
+   ```bash
+   echo "Explain quantum computing" | npx @j-o-r/hello-dave dave --ask --model grok-4
+   ```
+   - Provides a direct response using the specified model (e.g., `--model grok-4`).
+
+4. Connect to a WebSocket server (e.g., for networked agents):
+   ```bash
+   npx @j-o-r/hello-dave dave --connect ws://localhost:8080 --secret your_secret
+   ```
+
+5. Generate a custom agent using the spawner (snippet from `bin/dave.js` integration):
+   ```bash
+   npx @j-o-r/hello-dave spawnDave
+   ```
+   - Interactive: Follow prompts to create a new agent script in `bin/`.
+
+`bin/dave.js` also supports cache operations like `--list` (list sessions), `--search "query"`, `--clear`, and `--inspect path/to/log.ndjson`.
+
+## Usage
+
+### Core CLI via `bin/dave.js`
+
+`bin/dave.js` provides essential utilities and examples for agent spawning, WS interactions, and basic querying. Key commands:
+
+- **Ask Mode** (Interactive or Piped One-Shot):
+  ```bash
+  # Interactive
+  npx @j-o-r/hello-dave dave --ask --model grok-4 --temperature 0.2
+
+  # Piped one-shot
+  echo "What is quantum computing?" | npx @j-o-r/hello-dave dave --ask --model grok-4
+  ```
+  - Note: Piped input triggers a direct response via `directCall`; without pipe, it launches an interactive CLI session.
+  - `--model` option works for both modes (e.g., `grok-4`, `grok-4-1-fast-reasoning`).
+  - Uses `AgentManager` with xAI Grok API integration, adds tools like `web_search`, `x_search`, `open_link`, `send_email`, `history_search`.
+  - System prompt emphasizes brief, direct responses with step-by-step reasoning.
+
+- **WebSocket Client Mode** (with secrets for secure networking):
+  ```bash
+  # Interactive connection
+  npx @j-o-r/hello-dave dave --connect ws://localhost:8080 --secret "mysecret"
+
+  # Piped one-shot (direct CLI/cron messaging, no heartbeat needed)
+  echo "Predict the weather" | npx @j-o-r/hello-dave dave --connect ws://localhost:8080 --secret "mysecret"
+  echo "user_reset" | npx @j-o-r/hello-dave dave --connect ws://localhost:8080 --secret "mysecret"
+  ```
+
+- **Cache Management**:
+  ```bash
+  npx @j-o-r/hello-dave dave --list  # List sessions
+  npx @j-o-r/hello-dave dave --search "AI agents"  # Search history
+  npx @j-o-r/hello-dave dave --clear  # Clear cache
+  ```
+
+For custom agents, use `AgentManager` programmatically (see Examples).
+
+### Programmatic Usage with AgentManager
+
+```javascript
+import AgentManager from '@j-o-r/hello-dave';
+
+const agent = new AgentManager({ name: 'MyAgent', secret: 'optional_secret' });
+agent.setup({
+  prompt: 'You are a helpful assistant...',
+  api: 'xai',  // Uses unified xAI Grok API access
+  options: { model: 'grok-4', temperature: 0.7, tools: [{ type: 'web_search' }] },
+  toolsetMode: 'auto',
+  contextWindow: 500000
+});
+
+agent.addGenericToolcall('execute_bash_script');  // Post-setup generics
+agent.addGenericToolcall('read_file');
+agent.addGenericToolcall('write_file');
+
+await agent.start();  // Interactive CLI
+// Or: await agent.start(undefined, 8000, undefined, 'Intro', 'toolName', 'desc');  // WS server
+// Or: const response = await agent.directCall('Query');  // One-shot
+```
+
+Direct CLI/cron: Pipe inputs to custom scripts for non-interactive use. WS supports secrets for authentication; no heartbeat required due to event-driven messaging.
+
+## Examples
+
+Example scripts (e.g., `readmeDave.js` for README management, `todoDave.js` for task handling, `spawnDave.js` for agent creation) are now organized in the `examples/` folder. These demonstrate specialized agents using `AgentManager`, xAI Grok API integration, and tools.
+
+- **Link to Examples Folder**: Explore [examples/](examples/) for full scripts like `daisy.js` (music agent), `codeDave.js` (code review), `npmDave.js` (NPM inspector).
+
+### Snippet: Spawning Agents (from `examples/spawnDave.js` integration via `bin/dave.js`)
+
+`spawnDave` uses `AgentManager` to interactively generate new agent scripts:
+
+```javascript
+// Core setup in spawnDave
+const agent = new AgentManager({ name: 'spawn_dave', secret });
+agent.setup({
+  prompt: 'You are AgentCreator... [detailed prompt for portability, validation]',
+  api: 'xai',
+  options: { model: 'grok-4-fast-reasoning', tools: [{ type: 'web_search' }], reasoning: { effort: 'high' } },
+  toolsetMode: 'auto',
+  contextWindow: 500000
+});
+agent.addGenericToolcall('execute_bash_script');  // For project inspection
+agent.addGenericToolcall('read_file');
+agent.addGenericToolcall('write_file');  // For generating bin/ scripts
+
+await agent.start();  // Guides user to create e.g., bin/myagent.js
+```
+
+- Validates generated ESM code with `node --check` and tool rules (xAI natives pre-setup, generics post-setup).
+- Ensures absolute imports for portability.
+
+### Snippet: Using xAI Grok API Integration
+
+The unified xAI Grok API access supports options like reasoning and tools:
+
+```javascript
+// In AgentManager setup
+const options = {
+  model: 'grok-4-1-fast-reasoning',
+  temperature: 0.8,
+  tools: [{ type: 'web_search' }, { type: 'x_search', from_date: '2024-01-01' }],  // Native xAI tools
+  reasoning: { effort: 'medium', summary: 'auto' }  // Chain-of-thought support
+};
+```
+
+Detailed examples for xAI integration (e.g., advanced tool calls, reasoning) are planned (see TODO).
+
+### Running Examples
+
+```bash
+# Music agent (examples/daisy.js)
+chmod +x examples/daisy.js
+./examples/daisy.js "Generate lyrics for a pop song"
+
+# TODO manager (examples/todoDave.js)
+./examples/todoDave.js --connect ws://localhost:8080 --secret "secret"
+
+# Server setup for networked examples
+npx @j-o-r/hello-dave dave --ask --serve 8080  # Expose as WS server
+```
+
+## Development
+
+- **Scripts**: `npm test` (runs scenarios/grok.js), `npm run types` (generate TypeScript defs), `npm run release` (pack for release).
+- **Structure**: Core in `lib/` (AgentManager.js, wsCli.js, etc.), API integrations in `lib/API/`, examples in `examples/`, utils in `utils/`.
+- **Testing**: Basic validation via `npm test`. Unit tests for xAI integration planned (see TODO).
+- **Prep for v0.0.4**: Focus on spawnDave enhancements and release testing.
+
+## Changelog
+
+### v0.0.4 (Prep - March 2026)
+- Reorganized examples to `examples/` folder (readmeDave, todoDave, etc.).
+- Enhanced `bin/dave.js` for core utilities: spawning, WS with secrets, direct messaging.
+- Improved xAI Grok API integration; added native tools/reasoning support.
+- Removed heartbeat needs; direct CLI/cron support.
+- Added piped one-shot support to dave --ask.
+- TODO alignment: High-priority items noted (release prep, spawnDave enhancements).
+
+### v0.0.3 (Previous)
+- Initial WS secrets, generic tools, AgentManager refinements.
+
+Full history in git tags.
+
+## Contributing
+
+Contributions are welcome! Fork the repo at [https://codeberg.org/duin/hello-dave](https://codeberg.org/duin/hello-dave), create a feature branch, and submit a pull request.
+
+1. Install deps: `npm install`
+2. Self dep `npm run link-self`
+3. Run tests: `npm test`
+4. Generate types: `npm run types`
+5. Report issues: [https://codeberg.org/duin/hello-dave/issues](https://codeberg.org/duin/hello-dave/issues)
+
+Follow the [Code of Conduct](CODE_OF_CONDUCT.md) and Apache-2.0 license.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE) for details.
+
+## TODO Alignment
+
+This README aligns with high-priority items from [TODO.md](TODO.md):
+- **v0.0.4 Prep**: Changelog snippet added; release testing emphasized in Development.
+- **spawnDave Enhancements**: Highlighted in Examples with portability notes.
+- xAI integration tests/examples: Deferred to later (general enhancements).
+- Documentation tasks (e.g., AgentManager internals) integrated into Usage/Examples.
+- Deferred: Other xAI features to later; focus on core release and spawnDave.
+
+For full TODO, see [TODO.md](TODO.md).