@j-o-r/hello-dave 0.0.0

package/LICENSE

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright 2024 j-o-r Jorrit duin https://duin.xyz
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,207 @@
+# hello-dave (ALPHA)
+
+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
+
+> **Note:**
+> This is a personal project, created for my own 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 and only if you know what you're doing.
+>
+> How-tos and documentation are not finished; you may find rough edges.
+>
+> There are no fancy interfaces; everything is kept minimal and functional. 
+>
+> It is not yet able to connect to MCP servers; however, it is possible to connect Agents to the main Agent-server and so build a network of Agents.
+> `This is achieved by using function calls and WebSockets.
+> 
+> It is, e.g., possible to run a 'root' Agent with shell access and extend the Agent-server with it.
+>
+> Also, it is not tied to localhost. All Agents can run anywhere as long as they can make a connection to the Agent-server.
+>
+> The Agent-server can also connect to another Agent-server, running multiple hubs (from different nodes) each with their own specialty.
+
+This repo also ships example CLIs. The most compact example is examples/grok.js which shows how to use:
+- lib/AgentManager.js
+- lib/AgentServer.js
+- lib/AgentClient.js
+- lib/Cli.js
+
+## Requirements
+- Node.js >= 20 (package is ESM only: "type": "module")
+- API keys via environment variables (only set what you use):
+  - XAIKEY for x.ai (Grok)
+  - OPENAIKEY for OpenAI
+  - ANTHKEY for Anthropic
+  - BRAVESEARCHKEY for the Brave Search tool (optional tool)
+
+
+## Install
+
+- As a dependency in your project:
+  - npm i @j-o-r/hello-dave
+  - then use either the programmatic API (AgentManager) or the provided CLIs.
+
+### Bonus (when installed)
+
+Use the AI right away. Make sure you have an x.ai api key available.
+(Grok gives very good result)
+
+```bash
+export XAIKEY=.....
+```
+Now you can run the hello-dave code AI and the generic hello-dave 'ask' ai from within the current folder.
+Make sure to create a '.cache' folder first.
+```bash
+mkdir .cache
+```
+(I am used to run Agents within tmux sessions)
+
+```bash
+# Code AI with direct shell access (CAREFULL)
+npx hdCode
+
+# Ask Cli
+npx hdAsk
+# Ask One shot
+echo "Current date time" | npx hdAsk
+
+# Inspect a ndjson log/session file
+npx hdInspect .cache/hello-dave/...
+```
+
+- Interactive mode (no stdin):
+  - Use keys inside the TUI:
+    - ALT+d: exit
+    - ALT+r: reset conversation
+    - ALT+s: load a previous session
+    - ALT+k: show shortcuts/help
+
+- One-shot (pipe stdin):
+  - echo "explain sse vs websocket in 2 lines" | npx hdAsk
+
+- Switch parameters:
+  - node examples/grok.js --model grok-3-mini --tokens 4000 --context 10000 --temperature 0.3 --top_p 0.9
+  - node examples/grok.js --reasoning high
+
+- Enable tools (function calling):
+  - node examples/grok.js --tools javascript,bash
+    - javascript adds javascript_interpreter
+    - bash adds execute_bash_script
+
+- Run as a local dynamic tool server and connect a client:
+  - Terminal A: node examples/grok.js --serve 8000 --tools javascript,bash
+  - Terminal B: node examples/grok.js --connect ws://127.0.0.1:8000/ws
+
+Notes
+- With --serve, the agent starts a WS server on 127.0.0.1:PORT and exposes any connected clients as callable tools.
+- With --connect, an agent registers itself on that WS and will handle queries routed to its tool name.
+
+## Where data is stored
+
+Conversations, logs and request records are written under ./.cache/hello-dave/<agent-name>/
+- sessions/  incremental ndjson of messages
+- records/   per-day ndjson of timing/token/billing metadata
+- logs/      per-day ndjson of internal events
+
+These are managed by lib/Session.js and used by lib/Cli.js (ALT+s to load older sessions).
+
+## Programmatic use (AgentManager)
+
+AgentManager is the easiest way to embed the library in your own code. It creates a Prompt, optional ToolSet, session persistence, and can run as CLI or server/client.
+
+```js
+// ESM
+import AgentManager from '@j-o-r/hello-dave';
+
+// Minimal: direct call against Grok
+const agent = new AgentManager({ name: 'grok' });
+agent.setup({
+  prompt: 'Be precise and concise.',
+  api: 'grok',                        // 'gpt' | 'grok' | 'claude'
+  options: {                          // forwarded to the provider adapter
+    model: 'grok-4',
+    search_parameters: { mode: 'auto' }
+  },
+  toolsetMode: 'auto',                // 'auto' | 'required' | undefined
+  contextWindow: 250_000
+});
+
+const answer = await agent.directCall('Two bullet points on tail recursion.');
+console.log(answer);
+```
+
+### Adding your own tools (function calling)
+
+```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}!`
+  );
+}
+
+// Now the model can call say_hello when appropriate.
+```
+
+### Running an agent as a 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 an agent as a WS client (remote tool)
+
+```js
+agent.attach(
+  'code',
+  'Run JavaScript snippets safely and return output',
+  'ws://127.0.0.1:8000/ws'
+);
+```
+
+## Library building blocks (how grok.js uses them)
+
+- lib/AgentManager.js: façade that composes Prompt, ToolSet, Session and the provider adaptor (API.text[api]). Also starts CLI, WS server, or WS client.
+- lib/Cli.js: a small TUI with history, session loading, and handy shortcuts; it listens to Prompt events.
+- lib/AgentServer.js: local WS server that turns each attached client into a ToolSet function. Calls are routed over WS and responses returned as tool outputs.
+- lib/AgentClient.js: WS client that introduces itself (name + description) and processes queued requests exactly one at a time.
+
+Under the hood:
+- lib/Prompt.js: uniform message format (system, user, assistant, tool, reasoning, log), function-call plumbing, truncation, and provider-neutral calls.
+- lib/ToolSet.js: dead-simple JSON-schema + async method registry powering function calling.
+- lib/API/*: adaptors for x.ai (Grok), OpenAI Responses API, Anthropic Messages API, Brave Search tool.
+- lib/Session.js: on-disk persistence for sessions, logs and records.
+
+## TypeScript
+- Types are bundled. Main types for AgentManager are available via types/AgentManager.d.ts.
+
+## Utils
+
+```bash
+# Clear all session and log files
+npx hdClear
+# Read an ndjson file (session, log  etc.)
+npx hdInspect [path/to/file.ndjson]
+# Design / create a prompt. (AI prompt, x.ai key needed)
+npx hdPrompt
+# Ask a generic quesion to openai gpt-5-nano (openai key needed)
+npx hdAsk
+# Cli Connect to a websocket agent server
+npx hdConnect [ws://127.0.0.1:8000/ws]
+
+```
+
+## License
+Apache-2.0

package/bin/hdAsk.js

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+import AgentManager from '../lib/AgentManager.js';
+import { parseArgs, readIn } from '@j-o-r/sh';
+
+const name = 'hdAsk';
+const api = 'grok';
+
+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} */
+const options = {}
+// Set properties only if provided via command line (except model which has default)
+if (args['model'] || true) { // model gets default value
+	// @ts-ignore
+	options.model = args['model'] || 'grok-4-fast';
+}
+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
+}
+// Large context on grok-4-fast
+const contextWindow = args['context'] ? parseInt(args['context']) : 1900000;
+const toolsetMode = 'auto';
+
+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 130000
+--temperature [float] : -2 / +2
+--model [grok-4|grok-3|grok-3-mini|grok-3-mini-fast|grok-code-fast-1]
+--top_p [float]: number > 0, 0.1 means no top_p
+--reasoning [low|high]
+--tools [javascript,bash] comma seperated list
+e.g.
+grok.js --model grok-3-mini --tokens 4000 --context 10000
+
+`);
+	process.exit()
+}
+if (help) {
+	printHelp();
+}
+
+const prompt = `
+Respond briefly and directly, using minimal words. Reason step-by-step first. Focus solely on core point; avoid elaboration or follow-ups. If unclear, ask clarifying questions before proceeding.
+- open_link: [url] — open in local browser.
+- send_email: send to [email_address]; message: [message].
+ `.trim();
+
+const agent = new AgentManager({ name });
+agent.setup({
+	prompt,
+	api,
+	options,
+	toolsetMode,
+	contextWindow
+});
+	agent.addGenericToolcall('open_link');
+	agent.addGenericToolcall('send_email');
+
+const cliIntro = `
+${name} ${options.model}.
+- search  ${options.search_parameters.mode}
+- context: ${contextWindow}
+`.trim();
+const description = `
+Guide for this smart online AI Agent:
+- query: Formulate ONE efficient, comprehensive search query in natural language, combining multiple sources/subjects/domains; mention optional sources if needed. Avoid multiple queries—conso
+lidate into a single one.
+- open_link: [URL] — Open in local browser.
+- send_email: Send to [email_address]; Message: [message].
+`.trim();
+
+if (input === '' && serve) {
+	agent.enableServer(name, description, serve);
+}
+if (input !== '') {
+	// Direct input output
+	const res = await agent.directCall(input);
+	console.log(res);
+} else if(connect) {
+	agent.attach('online_agent', description, connect)
+} else {
+	agent.startCli(cliIntro);
+}

package/bin/hdClear.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env -S node
+
+// clear .cache/hello-dave if it exsists
+
+import path from 'node:path';
+import { SH } from '@j-o-r/sh';
+
+const folder = path.resolve('.cache', 'hello-dave');
+const res = await SH`[ -d "${folder}" ] && echo "yes" || echo "no"`.run();
+if (res === 'yes') {
+	console.log(`rm -fr ${folder}/*`);
+	await SH`rm -fr ${folder}/*`.run()
+}

package/bin/hdCode.js

@@ -0,0 +1,110 @@
+#!/usr/bin/env node
+import AgentManager from '../lib/AgentManager.js';
+import { parseArgs, readIn } from '@j-o-r/sh';
+import { systemInfo } from '../lib/fafs.js';
+
+const name = 'hdCode';
+const api = 'grok';
+
+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} */
+const options = {}
+// Set properties only if provided via command line (except model which has default)
+if (args['model'] || true) { // model gets default value
+	// @ts-ignore
+	options.model = args['model'] || 'grok-code-fast-1';
+}
+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;
+
+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 130000
+--temperature [float] : -2 / +2
+--model [grok-4|grok-3|grok-3-mini|grok-3-mini-fast|grok-code-fast-1]
+--top_p [float]: number > 0, 0.1 means no top_p
+--reasoning [low|high]
+--tools [javascript,bash] comma seperated list
+e.g.
+grok.js --model grok-3-mini --tokens 4000 --context 10000
+
+`);
+	process.exit()
+}
+
+if (help) {
+	printHelp();
+}
+
+const sys = await systemInfo();
+const prompt = `
+You are a coding assistant specializing in Bash and JavaScript (ESM/ESNext), with support for other languages. Assist by executing, reading, creating, querying, explaining, or helping with code. Use tools like 'execute_bash_script' for safe Bash execution. For writing and reading files, stay in the current working folder. Provide clear, step-by-step responses, examples, and ensure safety compliance.
+Update your 'memory' frequently.
+---env
+${sys}
+---
+ `.trim();
+const agent = new AgentManager({ name });
+agent.setup({
+	prompt,
+	api,
+	options,
+	toolsetMode,
+	contextWindow
+});
+const toolset = agent.getToolset();
+if (toolset) {
+	const addTools = (args['tools']) ? args['tools'].split(',') : ['bash'];
+	if (addTools.includes('javascript')) {
+		agent.addGenericToolcall('javascript_interpreter');
+	}
+	if (addTools.includes('bash')) {
+		agent.addGenericToolcall('execute_bash_script');
+	}
+}
+const cliIntro = `
+${name} ${options.model}.
+- search  ${options.search_parameters.mode}
+- context: ${contextWindow}
+`.trim();
+const description = `
+Gateway to a specialized coding assistant for Bash, JavaScript (ESM/ESNext), and other languages. Handles execution, reading, creation, querying, explaining, and code help, with safety and folder restrictions.
+`.trim();
+
+if (input === '' && serve) {
+	agent.enableServer('code', description, serve);
+}
+if (input !== '') {
+	// Direct input output
+	const res = await agent.directCall(input);
+	console.log(res);
+} else if (connect) {
+	agent.attach('code', description, connect)
+} else {
+	agent.startCli(cliIntro);
+}