@calamity-inc/slave 0.4.1 → 0.4.2

package/README.md

@@ -22,25 +22,29 @@ cat yap.txt | slave Summarize this text
 ```
 
 Options:
-- `-c`, `--cont`, `--continue` — add your previous invocation to the context of this one
-- `-a`, `--amend` — retry the previous invocation, using the context from before it
-- `-w`, `--web` — allow the model to search the web
-- `-n`, `--no-fs`, `--nofs` — disable filesystem access
-- `-s`, `--sandbox` — allow the model to use a docker container
-- `-p`, `--profile` `<name>` — use the specified profile
+- `--long`/`--multiline` — write a multiline prompt (mutually exclusive with piping text in)
+- `-c`/`--cont`/`--continue` — add your previous invocation to the context of this one
+- `-a`/`--amend` — retry the previous invocation, using the context from before it
+- `-w`/`--web` — allow the model to search the web
+- `-n`/`--no-fs`/`--nofs` — disable filesystem access
+- `-r`/`--readonly` — disable filesystem write access
+- `-s`/`--sandbox` — allow the model to use a docker container
+- `-p`/`--profile` `<name>` — use the specified profile
 
 Single-character flags can be combined, so `slave -cw prompt` is equivalent to `slave -c -w prompt`.
 
 Subcommands:
-- `--create-profile <name> <provider> <model> [--set-default]` — create a profile
+- `--create-profile` `<name>` `<provider>` `<model>` `[--set-default]` — create a profile
 	- `provider` can be `openai`, `anthropic`, or an OpenAI-compatible base URL like `http://127.0.0.1:1234/v1` for [LM Studio](https://lmstudio.ai/developers).
-- `--update-profile <name> <provider> <model> [--set-default]` — update a profile
-- `--set-default <profile name>` — set default profile
+- `--update-profile` `<name>` `<provider>` `<model>` `[--set-default]` — update a profile
+- `--set-default` `<profile name>` — set default profile
 - `--list-profiles` — list all profiles
-- `--delete-profile <name>` — delete a profile
-- `--update-api-key <provider>` — update an API Key
-- `--logs` — get info about logs
+- `--delete-profile` `<name>` — delete a profile
+- `--update-api-key` `<provider>` — update an API Key
+- `--set-system`/`--set-system-prompt` `[prompt]` `[--long|--multiline]` — set or clear the system prompt
+- `--get-system`/`--get-system-prompt` — get the system prompt
 - `--skills` — get info about skills
+- `--logs` — get info about logs
 
 ## Security
 

package/package.json

@@ -4,7 +4,7 @@
 		"type": "git",
 		"url": "git+https://github.com/calamity-inc/slave.git"
 	},
-	"version": "0.4.1",
+	"version": "0.4.2",
 	"type": "commonjs",
 	"bin": {
 		"slave": "src/main.js"

package/src/core.js

@@ -10,6 +10,7 @@ const ignore = require("ignore");
 
 const { logWrite } = require("./log.js");
 const { skills } = require("./skills.js");
+const { state } = require("./state.js");
 
 const slaveignore = ignore();
 if (fs.existsSync(".slaveignore")) {
@@ -62,11 +63,15 @@ const writeFileFromModel = (filePath, data, usesCRLF) => {
 };
 
 const getSystemPrompt = () => {
-	const entries = Object.entries(skills);
-	if (entries.length == 0) {
-		return undefined;
+	const parts = [];
+	if (state.systemPrompt) {
+		parts.push(state.systemPrompt);
 	}
-	return "You have the following skills available:\n" + entries.map(([name, skill]) => `- ${name}: ${skill.description}`).join("\n");
+	const skillEntries = Object.entries(skills);
+	if (skillEntries.length) {
+		parts.push("You have the following skills available:\n" + skillEntries.map(([name, skill]) => `- ${name}: ${skill.description}`).join("\n"));
+	}
+	return parts.length ? parts.join("\n\n") : undefined;
 };
 const getSkillResourcePath = (name, resourcePath) => {
 	if (Object.hasOwn(skills, name)) {
@@ -82,7 +87,7 @@ const getSkillResourcePath = (name, resourcePath) => {
 	return [false, "No such skill"];
 };
 
-let sandbox_name;
+let sandbox_name, sandbox_running;
 const getSandboxName = () => {
 	return sandbox_name;
 };
@@ -95,6 +100,10 @@ const ensureSandbox = () => {
 		// `docker pull ghcr.io/calamity-inc/slave-sandbox` is not needed to get the image, but would be needed to update it.
 		execFileSync("docker", ["run", "-d", "--name", sandbox_name, "ghcr.io/calamity-inc/slave-sandbox", "sleep", "infinity"], { encoding: "utf8" });
 	}
+	else if (!sandbox_running) {
+		execFileSync("docker", ["start", sandbox_name], { encoding: "utf8" });
+	}
+	sandbox_running = true;
 };
 const copyFileToSandbox = (hostPath, sbxPath) => {
 	ensureSandbox();
@@ -305,37 +314,41 @@ const initTools = (fs, sandbox, web_search) => {
 				},
 				strict: true,
 			},
-			{
-				type: "function",
-				name: "writeFile",
-				parameters: {
-					type: "object",
-					properties: {
-						path: { type: "string" },
-						data: { type: "string" },
+		);
+		if (fs != "readonly") {
+			tools.push(
+				{
+					type: "function",
+					name: "writeFile",
+					parameters: {
+						type: "object",
+						properties: {
+							path: { type: "string" },
+							data: { type: "string" },
+						},
+						required: [ "path", "data" ],
+						additionalProperties: false,
 					},
-					required: [ "path", "data" ],
-					additionalProperties: false,
+					strict: true,
 				},
-				strict: true,
-			},
-			{
-				type: "function",
-				name: "fileFindAndReplace",
-				parameters: {
-					type: "object",
-					properties: {
-						path: { type: "string" },
-						substring: { type: "string" },
-						replacement: { type: "string" },
-						expectedMatches: { type: ["number", "null"] },
+				{
+					type: "function",
+					name: "fileFindAndReplace",
+					parameters: {
+						type: "object",
+						properties: {
+							path: { type: "string" },
+							substring: { type: "string" },
+							replacement: { type: "string" },
+							expectedMatches: { type: ["number", "null"] },
+						},
+						required: [ "path", "substring", "replacement", "expectedMatches" ],
+						additionalProperties: false,
 					},
-					required: [ "path", "substring", "replacement", "expectedMatches" ],
-					additionalProperties: false,
+					strict: true,
 				},
-				strict: true,
-			},
-		);
+			);
+		}
 	}
 	if (sandbox) {
 		tools.push({
@@ -354,22 +367,22 @@ const initTools = (fs, sandbox, web_search) => {
 			strict: true,
 		});
 		if (fs) {
-			tools.push(
-				{
-					type: "function",
-					name: "sandboxCopyIn",
-					parameters: {
-						type: "object",
-						properties: {
-							hostPath: { type: "string" },
-							sbxPath: { type: "string" },
-						},
-						required: [ "hostPath", "sbxPath" ],
-						additionalProperties: false,
+			tools.push({
+				type: "function",
+				name: "sandboxCopyIn",
+				parameters: {
+					type: "object",
+					properties: {
+						hostPath: { type: "string" },
+						sbxPath: { type: "string" },
 					},
-					strict: true,
+					required: [ "hostPath", "sbxPath" ],
+					additionalProperties: false,
 				},
-				{
+				strict: true,
+			});
+			if (fs != "readonly") {
+				tools.push({
 					type: "function",
 					name: "sandboxCopyOut",
 					parameters: {
@@ -382,8 +395,8 @@ const initTools = (fs, sandbox, web_search) => {
 						additionalProperties: false,
 					},
 					strict: true,
-				},
-			);
+				});
+			}
 		}
 	}
 	if (Object.keys(skills).length) {
@@ -598,6 +611,7 @@ const anthropic_generateResponseOptionallyUsingTools = async (client, model, inp
 };
 
 module.exports = {
+	getSystemPrompt,
 	initTools,
 	getSandboxName,
 	setSandboxName,

package/src/main.js

@@ -10,10 +10,12 @@ async function main() {
 		.usage("[options] [--] [prompt...]")
 		.description("Vibe coding without the kaboom factor.")
 		.argument("[prompt...]")
+		.option("--long, --multiline", "write a multiline prompt")
 		.option("-c, --continue", "add your previous invocation to the context of this one").option("--cont")
 		.option("-a, --amend", "retry the previous invocation, using the context from before it")
 		.option("-w, --web", "allow the model to search the web")
 		.option("-n, --no-fs", "disable filesystem access").option("--nofs")
+		.option("-r, --readonly", "disable filesystem write access")
 		.option("-s, --sandbox", "allow the model to use a docker container")
 		.option("-p, --profile <name>", "profile name")
 		.option("--create-profile <name> <provider> <model>", "create a profile")
@@ -22,8 +24,10 @@ async function main() {
 		.option("--list-profiles", "list all profiles")
 		.option("--delete-profile <name>", "delete a profile")
 		.option("--update-api-key <provider>", "update an API key")
-		.option("--logs", "get info about logs")
+		.option("--set-system, --set-system-prompt", "set or clear the system prompt")
+		.option("--get-system, --get-system-prompt", "get the system prompt")
 		.option("--skills", "get info about skills")
+		.option("--logs", "get info about logs")
 		.helpOption("-?, --help", "display help")
 		.parse();
 	const options = program.opts();
@@ -106,12 +110,6 @@ async function main() {
 		console.log("Saved.");
 		process.exit(0);
 	}
-	if (options.logs) {
-		const { logDir } = require("./paths.js");
-		console.log(`Each invocation that prompts a model creates a log file in ${logDir}`);
-		console.log(`When a new log file is created, any log file older than 30 days is deleted.`);
-		process.exit(0);
-	}
 	if (options.skills) {
 		const { skillsDir, skills } = require("./skills.js");
 		console.log(`Skills are loaded from ${skillsDir}`);
@@ -124,6 +122,23 @@ async function main() {
 		}
 		process.exit(0);
 	}
+	if (options.logs) {
+		const { logDir } = require("./paths.js");
+		console.log(`Each invocation that prompts a model creates a log file in ${logDir}`);
+		console.log(`When a new log file is created, any log file older than 30 days is deleted.`);
+		process.exit(0);
+	}
+	if (options.getSystemPrompt) {
+		const { getSystemPrompt } = require("./core.js");
+		const sp = getSystemPrompt();
+		if (sp !== undefined) {
+			console.log(sp);
+		}
+		else {
+			console.log("No system prompt.");
+		}
+		process.exit(0);
+	}
 
 	const { markdownToConsoleText } = require("./markdown.js");
 
@@ -142,6 +157,43 @@ async function main() {
 	}
 
 	let prompt = program.args.join(" ").trim();
+	if (options.multiline) {
+		const { createInterface } = require("node:readline");
+		console.log("Enter your prompt (Ctrl+D on an empty line to finish):");
+		const lines = [];
+		if (prompt) {
+			lines.push(prompt);
+			console.log("> " + prompt);
+		}
+		prompt = await new Promise((resolve) => {
+			const rl = createInterface({ input: process.stdin, output: process.stdout });
+			rl.setPrompt("> ");
+			rl.prompt();
+			rl.on("line", (line) => {
+				lines.push(line);
+				rl.prompt();
+			});
+			rl.on("close", () => {
+				resolve(lines.join("\n"));
+			});
+		});
+		console.log("\n");
+	}
+	let printedPrompt = prompt.replaceAll("\r", "<CR>").replaceAll("\n", "<NL>").replaceAll("\t", "    ");
+
+	if (options.setSystemPrompt) {
+		state.systemPrompt = prompt.trim();
+		if (state.systemPrompt) {
+			console.log("Set custom system prompt: " + printedPrompt);
+		}
+		else {
+			delete state.systemPrompt;
+			console.log("Cleared custom system prompt.");
+		}
+		saveState();
+		process.exit(0);
+	}
+
 	if (!prompt) {
 		console.error("No prompt given.");
 		process.exit(1);
@@ -167,33 +219,41 @@ async function main() {
 		previous_provider_state = state.providerStates[profile.provider].previous_previous;
 		setSandboxName(state.providerStates[profile.provider].sandbox_name);
 	}
-	const filesystemEnabled = options.fs !== false && !options.nofs;
-	initTools(filesystemEnabled, options.sandbox, options.web);
+	const fsMode = (options.fs !== false && !options.nofs) && (options.readonly ? "readonly" : true);
+	initTools(fsMode, options.sandbox, options.web);
+	if (state.systemPrompt) {
+		overrides.push("custom system prompt");
+	}
 	if (Object.keys(skills).length) {
 		overrides.push(`${Object.keys(skills).length} skill${Object.keys(skills).length == 1 ? "" : "s"}`);
 	}
 	if (options.web) {
 		overrides.push("web search enabled");
 	}
-	if (!filesystemEnabled) {
+	if (!fsMode) {
 		overrides.push("no filesystem access");
 	}
+	else if (fsMode == "readonly") {
+		overrides.push("read-only filesystem access");
+	}
 	if (options.sandbox) {
 		overrides.push("sandbox enabled");
 	}
 
-	logWriteBoth((previous_provider_state ? "FOLLOW-UP" : "PROMPT") + ": " + prompt);
 	if (!process.stdin.isTTY) {
 		const chunks = [];
 		for await (const chunk of process.stdin) {
 			chunks.push(chunk);
 		}
 		prompt = `${Buffer.concat(chunks).toString("utf8")}\n\n${prompt}`;
-		overrides.push("stdin provided");
+		printedPrompt = `[stdin]<NL><NL>${printedPrompt}`;
 	}
+	console.log((previous_provider_state ? "FOLLOW-UP" : "PROMPT") + ": " + printedPrompt);
+	logWrite((previous_provider_state ? "FOLLOW-UP" : "PROMPT") + ": " + prompt);
 	logWriteBoth(`(${overrides.join(", ")})\n`);
 
-	//console.log({ model: profile.model, prompt, previous_provider_state });
+	/*console.log({ model: profile.model, prompt, previous_provider_state, fsMode });
+	return;*/
 
 	const clientOpts = {
 		apiKey: state.apiKeys[profile.provider],
@@ -220,6 +280,9 @@ async function main() {
 	saveState();
 	if (response.used_tools) {
 		logWriteBoth("");
+		if (getSandboxName()) {
+			execFileSync("docker", ["stop", getSandboxName(), "-t", "0"], { encoding: "utf8" });
+		}
 	}
 	console.log(markdownToConsoleText(response.output_text) + "\n");
 	logWrite(response.output_text);