@lazarusrolando/crayoncli 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +3 -0
- package/README.md +20 -2
- package/dist/agent/agent.js +27 -0
- package/dist/cli/interactive.js +16 -0
- package/dist/index.js +15 -0
- package/dist/providers/openai.js +11 -0
- package/dist/providers/provider.js +1 -0
- package/dist/tools/filesystem.js +29 -0
- package/dist/tools/registry.js +8 -0
- package/dist/tools/search.js +18 -0
- package/dist/tools/terminal.js +13 -0
- package/package.json +29 -6
- package/src/agent/agent.ts +3 -0
- package/src/cli/interactive.ts +2 -0
- package/src/index.ts +3 -0
- package/src/providers/openai.ts +10 -0
- package/src/providers/provider.ts +4 -0
- package/src/tools/filesystem.ts +9 -0
- package/src/tools/registry.ts +3 -0
- package/src/tools/search.ts +3 -0
- package/src/tools/terminal.ts +4 -0
- package/tsconfig.json +1 -0
package/.env.example
ADDED
package/README.md
CHANGED
|
@@ -1,3 +1,21 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CRAYON — Open-source Crayon-style CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Node.js/TypeScript coding agent for local projects.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
```powershell
|
|
8
|
+
npm install
|
|
9
|
+
Copy-Item .env.example .env
|
|
10
|
+
# edit .env and add OPENAI_API_KEY
|
|
11
|
+
npm run build
|
|
12
|
+
npm link
|
|
13
|
+
crayon
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Direct task:
|
|
17
|
+
```powershell
|
|
18
|
+
crayon "inspect this project and fix the failing tests"
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
The agent can read/write files, search source code, and run development commands. Destructive shell commands require approval.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { OpenAIProvider } from "../providers/openai.js";
|
|
2
|
+
import { definitions, execute } from "../tools/registry.js";
|
|
3
|
+
const SYSTEM = `You are CRAYON, an autonomous coding agent. Work inside the current project. Inspect before editing. Prefer small, safe changes. Explain what you are doing. Use tools to read/search/edit/run tests. Never claim a change was made unless the tool succeeded. Do not access files outside the project root.`;
|
|
4
|
+
export class Agent {
|
|
5
|
+
provider = new OpenAIProvider();
|
|
6
|
+
messages = [{ role: "system", content: SYSTEM }];
|
|
7
|
+
async run(input) { this.messages.push({ role: "user", content: input }); for (let i = 0; i < 30; i++) {
|
|
8
|
+
const r = await this.provider.chat(this.messages, definitions);
|
|
9
|
+
if (r.content)
|
|
10
|
+
console.log(`\n${r.content}`);
|
|
11
|
+
if (!r.toolCalls.length)
|
|
12
|
+
return;
|
|
13
|
+
if (r.content)
|
|
14
|
+
this.messages.push({ role: "assistant", content: r.content });
|
|
15
|
+
for (const c of r.toolCalls) {
|
|
16
|
+
let result = "";
|
|
17
|
+
try {
|
|
18
|
+
result = await execute(c.name, JSON.parse(c.arguments));
|
|
19
|
+
}
|
|
20
|
+
catch (e) {
|
|
21
|
+
result = `ERROR: ${e instanceof Error ? e.message : String(e)}`;
|
|
22
|
+
}
|
|
23
|
+
this.messages.push({ role: "tool", tool_call_id: c.id, content: String(result) });
|
|
24
|
+
console.log(`\n● ${c.name}`);
|
|
25
|
+
}
|
|
26
|
+
} throw new Error("Agent reached maximum tool iterations."); }
|
|
27
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import readline from "node:readline/promises";
|
|
2
|
+
import { stdin as input, stdout as output } from "node:process";
|
|
3
|
+
import { Agent } from "../agent/agent.js";
|
|
4
|
+
export async function interactive() { console.log("\n╭──────────────────────────────────────────────╮\n│ CRAYON CODING AGENT │\n│ Open-source Crayon-style CLI │\n╰──────────────────────────────────────────────╯\n"); const rl = readline.createInterface({ input, output }); const agent = new Agent(); while (true) {
|
|
5
|
+
const q = (await rl.question("\n> ")).trim();
|
|
6
|
+
if (!q)
|
|
7
|
+
continue;
|
|
8
|
+
if (["exit", "quit"].includes(q.toLowerCase()))
|
|
9
|
+
break;
|
|
10
|
+
try {
|
|
11
|
+
await agent.run(q);
|
|
12
|
+
}
|
|
13
|
+
catch (e) {
|
|
14
|
+
console.error(`\n✖ ${e instanceof Error ? e.message : e}`);
|
|
15
|
+
}
|
|
16
|
+
} rl.close(); }
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import "dotenv/config";
|
|
3
|
+
import { Command } from "commander";
|
|
4
|
+
import { interactive } from "./cli/interactive.js";
|
|
5
|
+
import { Agent } from "./agent/agent.js";
|
|
6
|
+
const p = new Command();
|
|
7
|
+
p.name("crayon").description("Open-source AI coding agent CLI").argument("[prompt]", "task for the coding agent").option("-v, --version", "show version").action(async (prompt) => { if (!process.env.OPENAI_API_KEY) {
|
|
8
|
+
console.error("Missing OPENAI_API_KEY. Copy .env.example to .env and add your key.");
|
|
9
|
+
process.exit(1);
|
|
10
|
+
} if (prompt) {
|
|
11
|
+
await new Agent().run(prompt);
|
|
12
|
+
}
|
|
13
|
+
else
|
|
14
|
+
await interactive(); });
|
|
15
|
+
p.parseAsync();
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import OpenAI from "openai";
|
|
2
|
+
export class OpenAIProvider {
|
|
3
|
+
client;
|
|
4
|
+
model;
|
|
5
|
+
constructor() { this.client = new OpenAI({ apiKey: process.env.OPENAI_API_KEY, baseURL: process.env.OPENAI_BASE_URL }); this.model = process.env.CRAYON_MODEL || "gpt-5.6"; }
|
|
6
|
+
async chat(messages, tools) {
|
|
7
|
+
const r = await this.client.chat.completions.create({ model: this.model, messages: messages, tools: tools, tool_choice: "auto" });
|
|
8
|
+
const m = r.choices[0]?.message;
|
|
9
|
+
return { content: m?.content ?? null, toolCalls: (m?.tool_calls ?? []).map((x) => ({ id: x.id, name: x.function.name, arguments: x.function.arguments })) };
|
|
10
|
+
}
|
|
11
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import fs from "node:fs/promises";
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
const root = process.cwd();
|
|
4
|
+
function safe(p) { const r = path.resolve(root, p); if (r !== root && !r.startsWith(root + path.sep))
|
|
5
|
+
throw new Error("Path escapes project root"); return r; }
|
|
6
|
+
export const fsTools = [
|
|
7
|
+
{ name: "read_file", description: "Read a UTF-8 text file in the project.", parameters: { type: "object", properties: { path: { type: "string" } }, required: ["path"] } },
|
|
8
|
+
{ name: "write_file", description: "Write or replace a UTF-8 text file in the project.", parameters: { type: "object", properties: { path: { type: "string" }, content: { type: "string" } }, required: ["path", "content"] } },
|
|
9
|
+
{ name: "list_files", description: "List project files recursively, excluding common dependency/build folders.", parameters: { type: "object", properties: { path: { type: "string" } }, required: [] } },
|
|
10
|
+
];
|
|
11
|
+
export async function runFs(name, args) { if (name === "read_file")
|
|
12
|
+
return await fs.readFile(safe(args.path), "utf8"); if (name === "write_file") {
|
|
13
|
+
await fs.mkdir(path.dirname(safe(args.path)), { recursive: true });
|
|
14
|
+
await fs.writeFile(safe(args.path), args.content, "utf8");
|
|
15
|
+
return `Wrote ${args.path}`;
|
|
16
|
+
} if (name === "list_files") {
|
|
17
|
+
const out = [];
|
|
18
|
+
async function walk(d) { for (const e of await fs.readdir(d, { withFileTypes: true })) {
|
|
19
|
+
if (["node_modules", ".git", "dist", "build", ".next"].includes(e.name))
|
|
20
|
+
continue;
|
|
21
|
+
const p = path.join(d, e.name);
|
|
22
|
+
if (e.isDirectory())
|
|
23
|
+
await walk(p);
|
|
24
|
+
else
|
|
25
|
+
out.push(path.relative(root, p));
|
|
26
|
+
} }
|
|
27
|
+
await walk(safe(args.path || "."));
|
|
28
|
+
return out.slice(0, 500).join("\n");
|
|
29
|
+
} throw new Error("Unknown filesystem tool"); }
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { fsTools, runFs } from "./filesystem.js";
|
|
2
|
+
import { searchTool, searchCode } from "./search.js";
|
|
3
|
+
import { terminalTool, runCommand } from "./terminal.js";
|
|
4
|
+
export const definitions = [...fsTools.map(x => ({ type: "function", function: x })), { type: "function", function: searchTool }, { type: "function", function: terminalTool }];
|
|
5
|
+
export async function execute(name, args) { if (["read_file", "write_file", "list_files"].includes(name))
|
|
6
|
+
return runFs(name, args); if (name === "search_code")
|
|
7
|
+
return searchCode(args.query); if (name === "run_command")
|
|
8
|
+
return runCommand(args.command); throw new Error(`Unknown tool: ${name}`); }
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import fs from "node:fs/promises";
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
export const searchTool = { name: "search_code", description: "Search text across project source files.", parameters: { type: "object", properties: { query: { type: "string" } }, required: ["query"] } };
|
|
4
|
+
export async function searchCode(query) { const root = process.cwd(), hits = []; async function walk(d) { for (const e of await fs.readdir(d, { withFileTypes: true })) {
|
|
5
|
+
if (["node_modules", ".git", "dist", "build", ".next"].includes(e.name))
|
|
6
|
+
continue;
|
|
7
|
+
const p = path.join(d, e.name);
|
|
8
|
+
if (e.isDirectory())
|
|
9
|
+
await walk(p);
|
|
10
|
+
else {
|
|
11
|
+
try {
|
|
12
|
+
const s = await fs.readFile(p, "utf8");
|
|
13
|
+
if (s.includes(query))
|
|
14
|
+
hits.push(path.relative(root, p));
|
|
15
|
+
}
|
|
16
|
+
catch { }
|
|
17
|
+
}
|
|
18
|
+
} } await walk(root); return hits.slice(0, 100).join("\n") || "No matches."; }
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { exec } from "node:child_process";
|
|
2
|
+
import { promisify } from "node:util";
|
|
3
|
+
import readline from "node:readline/promises";
|
|
4
|
+
const ex = promisify(exec);
|
|
5
|
+
export const terminalTool = { name: "run_command", description: "Run a shell command in the project. Use only for safe development commands.", parameters: { type: "object", properties: { command: { type: "string" } }, required: ["command"] } };
|
|
6
|
+
const dangerous = /\b(del|erase|rmdir|rm|format|shutdown|reboot|diskpart|git\s+reset\s+--hard)\b/i;
|
|
7
|
+
export async function runCommand(command) { if (dangerous.test(command)) {
|
|
8
|
+
const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
|
|
9
|
+
const a = await rl.question(`Approve potentially destructive command? ${command} [y/N] `);
|
|
10
|
+
rl.close();
|
|
11
|
+
if (a.toLowerCase() !== "y")
|
|
12
|
+
return "Command denied by user.";
|
|
13
|
+
} const r = await ex(command, { cwd: process.cwd(), timeout: 120000, maxBuffer: 5 * 1024 * 1024, shell: process.platform === "win32" ? "powershell.exe" : true }); return (r.stdout + r.stderr).trim(); }
|
package/package.json
CHANGED
|
@@ -1,6 +1,29 @@
|
|
|
1
|
-
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "@lazarusrolando/crayoncli",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"bin": {
|
|
6
|
+
"crayon": "./dist/index.js"
|
|
7
|
+
},
|
|
8
|
+
"scripts": {
|
|
9
|
+
"dev": "tsx src/index.ts",
|
|
10
|
+
"build": "tsc",
|
|
11
|
+
"start": "node dist/index.js"
|
|
12
|
+
},
|
|
13
|
+
"dependencies": {
|
|
14
|
+
"chalk": "^5.4.1",
|
|
15
|
+
"commander": "^14.0.0",
|
|
16
|
+
"dotenv": "^17.2.2",
|
|
17
|
+
"fast-glob": "^3.3.3",
|
|
18
|
+
"inquirer": "^12.9.4",
|
|
19
|
+
"openai": "^6.0.0",
|
|
20
|
+
"ora": "^8.2.0",
|
|
21
|
+
"pino": "^9.9.0",
|
|
22
|
+
"uuid": "^11.1.0"
|
|
23
|
+
},
|
|
24
|
+
"devDependencies": {
|
|
25
|
+
"@types/node": "^24.5.2",
|
|
26
|
+
"tsx": "^4.19.2",
|
|
27
|
+
"typescript": "^5.9.2"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type {Message} from "../providers/provider.js"; import {OpenAIProvider} from "../providers/openai.js"; import {definitions,execute} from "../tools/registry.js";
|
|
2
|
+
const SYSTEM=`You are CRAYON, an autonomous coding agent. Work inside the current project. Inspect before editing. Prefer small, safe changes. Explain what you are doing. Use tools to read/search/edit/run tests. Never claim a change was made unless the tool succeeded. Do not access files outside the project root.`;
|
|
3
|
+
export class Agent { private provider=new OpenAIProvider(); private messages:Message[]=[{role:"system",content:SYSTEM}]; async run(input:string){this.messages.push({role:"user",content:input}); for(let i=0;i<30;i++){const r=await this.provider.chat(this.messages,definitions); if(r.content) console.log(`\n${r.content}`); if(!r.toolCalls.length) return; if(r.content)this.messages.push({role:"assistant",content:r.content}); for(const c of r.toolCalls){let result="";try{result=await execute(c.name,JSON.parse(c.arguments));}catch(e){result=`ERROR: ${e instanceof Error?e.message:String(e)}`;} this.messages.push({role:"tool",tool_call_id:c.id,content:String(result)}); console.log(`\n● ${c.name}`);}} throw new Error("Agent reached maximum tool iterations.");}}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import readline from "node:readline/promises"; import {stdin as input,stdout as output} from "node:process"; import {Agent} from "../agent/agent.js";
|
|
2
|
+
export async function interactive(){console.log("\n╭──────────────────────────────────────────────╮\n│ CRAYON CODING AGENT │\n│ Open-source Crayon-style CLI │\n╰──────────────────────────────────────────────╯\n"); const rl=readline.createInterface({input,output}); const agent=new Agent(); while(true){const q=(await rl.question("\n> ")).trim();if(!q)continue;if(["exit","quit"].includes(q.toLowerCase()))break;try{await agent.run(q);}catch(e){console.error(`\n✖ ${e instanceof Error?e.message:e}`);}}rl.close();}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import "dotenv/config"; import {Command} from "commander"; import {interactive} from "./cli/interactive.js"; import {Agent} from "./agent/agent.js";
|
|
3
|
+
const p=new Command();p.name("crayon").description("Open-source AI coding agent CLI").argument("[prompt]","task for the coding agent").option("-v, --version","show version").action(async(prompt:string|undefined)=>{if(!process.env.OPENAI_API_KEY){console.error("Missing OPENAI_API_KEY. Copy .env.example to .env and add your key.");process.exit(1);}if(prompt){await new Agent().run(prompt);}else await interactive();});p.parseAsync();
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import OpenAI from "openai";
|
|
2
|
+
import type { ModelProvider, Message, ToolDef, ChatResult } from "./provider.js";
|
|
3
|
+
export class OpenAIProvider implements ModelProvider {
|
|
4
|
+
private client: OpenAI; private model: string;
|
|
5
|
+
constructor() { this.client = new OpenAI({ apiKey: process.env.OPENAI_API_KEY, baseURL: process.env.OPENAI_BASE_URL }); this.model = process.env.CRAYON_MODEL || "gpt-5.6"; }
|
|
6
|
+
async chat(messages: Message[], tools: ToolDef[]): Promise<ChatResult> {
|
|
7
|
+
const r = await this.client.chat.completions.create({ model: this.model, messages: messages as any, tools: tools as any, tool_choice: "auto" });
|
|
8
|
+
const m = r.choices[0]?.message; return { content: m?.content ?? null, toolCalls: (m?.tool_calls ?? []).map((x: any) => ({ id:x.id, name:x.function.name, arguments:x.function.arguments })) };
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export type Message = { role: "system" | "user" | "assistant" | "tool"; content: string; tool_call_id?: string };
|
|
2
|
+
export type ToolDef = { type: "function"; function: { name: string; description: string; parameters: Record<string, unknown> } };
|
|
3
|
+
export type ChatResult = { content: string | null; toolCalls: { id: string; name: string; arguments: string }[] };
|
|
4
|
+
export interface ModelProvider { chat(messages: Message[], tools: ToolDef[]): Promise<ChatResult>; }
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import fs from "node:fs/promises"; import path from "node:path";
|
|
2
|
+
const root = process.cwd();
|
|
3
|
+
function safe(p:string){ const r=path.resolve(root,p); if(r!==root && !r.startsWith(root+path.sep)) throw new Error("Path escapes project root"); return r; }
|
|
4
|
+
export const fsTools = [
|
|
5
|
+
{name:"read_file",description:"Read a UTF-8 text file in the project.",parameters:{type:"object",properties:{path:{type:"string"}},required:["path"]}},
|
|
6
|
+
{name:"write_file",description:"Write or replace a UTF-8 text file in the project.",parameters:{type:"object",properties:{path:{type:"string"},content:{type:"string"}},required:["path","content"]}},
|
|
7
|
+
{name:"list_files",description:"List project files recursively, excluding common dependency/build folders.",parameters:{type:"object",properties:{path:{type:"string"}},required:[]}},
|
|
8
|
+
];
|
|
9
|
+
export async function runFs(name:string,args:any){ if(name==="read_file") return await fs.readFile(safe(args.path),"utf8"); if(name==="write_file"){await fs.mkdir(path.dirname(safe(args.path)),{recursive:true});await fs.writeFile(safe(args.path),args.content,"utf8");return `Wrote ${args.path}`;} if(name==="list_files"){const out:string[]=[]; async function walk(d:string){for(const e of await fs.readdir(d,{withFileTypes:true})){if(["node_modules",".git","dist","build",".next"].includes(e.name))continue;const p=path.join(d,e.name); if(e.isDirectory()) await walk(p); else out.push(path.relative(root,p));}} await walk(safe(args.path||".")); return out.slice(0,500).join("\n");} throw new Error("Unknown filesystem tool"); }
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import {fsTools,runFs} from "./filesystem.js"; import {searchTool,searchCode} from "./search.js"; import {terminalTool,runCommand} from "./terminal.js"; import type {ToolDef} from "../providers/provider.js";
|
|
2
|
+
export const definitions:ToolDef[]=[...fsTools.map(x=>({type:"function" as const,function:x})),{type:"function",function:searchTool},{type:"function",function:terminalTool}];
|
|
3
|
+
export async function execute(name:string,args:any){if(["read_file","write_file","list_files"].includes(name))return runFs(name,args);if(name==="search_code")return searchCode(args.query);if(name==="run_command")return runCommand(args.command);throw new Error(`Unknown tool: ${name}`);}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import fs from "node:fs/promises"; import path from "node:path";
|
|
2
|
+
export const searchTool={name:"search_code",description:"Search text across project source files.",parameters:{type:"object",properties:{query:{type:"string"}},required:["query"]}};
|
|
3
|
+
export async function searchCode(query:string){const root=process.cwd(), hits:string[]=[]; async function walk(d:string){for(const e of await fs.readdir(d,{withFileTypes:true})){if(["node_modules",".git","dist","build",".next"].includes(e.name))continue;const p=path.join(d,e.name);if(e.isDirectory()) await walk(p); else {try{const s=await fs.readFile(p,"utf8");if(s.includes(query)) hits.push(path.relative(root,p));}catch{}}}} await walk(root); return hits.slice(0,100).join("\n")||"No matches.";}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import {exec} from "node:child_process"; import {promisify} from "node:util"; import readline from "node:readline/promises";
|
|
2
|
+
const ex=promisify(exec); export const terminalTool={name:"run_command",description:"Run a shell command in the project. Use only for safe development commands.",parameters:{type:"object",properties:{command:{type:"string"}},required:["command"]}};
|
|
3
|
+
const dangerous=/\b(del|erase|rmdir|rm|format|shutdown|reboot|diskpart|git\s+reset\s+--hard)\b/i;
|
|
4
|
+
export async function runCommand(command:string){if(dangerous.test(command)){const rl=readline.createInterface({input:process.stdin,output:process.stdout});const a=await rl.question(`Approve potentially destructive command? ${command} [y/N] `);rl.close();if(a.toLowerCase()!=="y")return "Command denied by user.";} const r=await ex(command,{cwd:process.cwd(),timeout:120000,maxBuffer:5*1024*1024,shell:process.platform==="win32"?"powershell.exe":true});return (r.stdout+r.stderr).trim();}
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"compilerOptions":{"target":"ES2022","module":"NodeNext","moduleResolution":"NodeNext","strict":true,"esModuleInterop":true,"skipLibCheck":true,"outDir":"dist","rootDir":"src"},"include":["src/**/*.ts"]}
|