Skip to content

Fix CLI run defaults and config validation #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vamgan merged 1 commit into from
May 11, 2026
Merged

Fix CLI run defaults and config validation #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 35 additions & 13 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,23 @@ import { AgentDispatchClient } from "@agent-dispatch/sdk";
import { SqliteTaskStore } from "@agent-dispatch/store-sqlite";
import { AwsAgentCoreAdapter } from "@agent-dispatch/adapter-aws-agentcore";

export function buildProgram(output: Pick<Console, "log" | "error"> = console): Command {
export interface CliOutput {
log(value: string): void;
error(value: string): void;
write?(value: string): void;
}

const PLACEHOLDER_RUNTIME_ARN = "arn:aws:bedrock-agentcore:us-west-2:123456789012:agent/00000000-0000-0000-0000-000000000000:1";

export function buildProgram(output: CliOutput = console): Command {
const program = new Command();

program.name("agentdispatch").description("Provider-neutral agent task dispatcher").version(readPackageVersion());

program
.command("init")
.option("--config <path>", "Config file", "agentdispatch.config.json")
.option("--runtime-arn <arn>", "Existing AWS AgentCore runtime ARN", "arn:aws:bedrock-agentcore:us-west-2:123456789012:agent/00000000-0000-0000-0000-000000000000:1")
.option("--runtime-arn <arn>", "Existing AWS AgentCore runtime ARN")
.option("--region <region>", "AWS region", "us-west-2")
.action(async (options) => {
const config = sampleConfig(options.region, options.runtimeArn);
Expand Down Expand Up @@ -80,7 +88,7 @@ export function buildProgram(output: Pick<Console, "log" | "error"> = console):
.option("--account-profile <name>")
.option("--capability <capability>")
.option("--task-type <type>")
.option("--target-mode <mode>", "Target mode", "session")
.option("--target-mode <mode>", "Target mode")
.option("--target-details-json <json>", "JSON object merged into target.details")
.option("--instruction <text>")
.option("--command <command>")
Expand All @@ -98,7 +106,7 @@ export function buildProgram(output: Pick<Console, "log" | "error"> = console):
const handle = await client.dispatchTask(request);
output.log(JSON.stringify(handle, null, 2));
if (options.wait) {
const result = await waitForTask(client, handle.taskId, Number(options.pollIntervalMs), Number(options.timeoutMs));
const result = await waitForTask(client, handle.taskId, Number(options.pollIntervalMs), Number(options.timeoutMs), output);
output.log(JSON.stringify(result, null, 2));
}
});
Expand Down Expand Up @@ -155,7 +163,9 @@ export async function loadConfig(path: string): Promise<AgentDispatchConfig> {
return config;
}

export function sampleConfig(region: string, runtimeArn: string): AgentDispatchConfig {
export function sampleConfig(region: string, runtimeArn?: string): AgentDispatchConfig {
const details: Record<string, unknown> = { qualifier: "DEFAULT" };
if (runtimeArn) details.runtimeArn = runtimeArn;
return {
stateDir: ".agentdispatch",
accounts: {
Expand All @@ -171,10 +181,7 @@ export function sampleConfig(region: string, runtimeArn: string): AgentDispatchC
capability: "agent-runtime",
adapter: "aws-agentcore",
account: "dev-aws",
details: {
runtimeArn,
qualifier: "DEFAULT"
}
details
}
},
runtimes: {
Expand Down Expand Up @@ -203,6 +210,15 @@ export function createDispatchRequest(config: AgentDispatchConfig, options: Reco
if (!provider || !accountProfile || !capability) {
throw new Error("Missing provider/account/capability. Pass CLI options or configure defaults.runtime in agentdispatch.config.json.");
}
if (taskType === "command.run" && !options.command) {
throw new Error("Pass --command when dispatching command.run tasks.");
}
if (taskType === "agent.run" && !options.instruction) {
throw new Error("Pass --instruction when dispatching agent.run tasks.");
}
if (options.command && options.instruction && !options.taskType) {
throw new Error("Pass either --instruction or --command, or set --task-type explicitly.");
}
return {
provider,
accountProfile,
Expand Down Expand Up @@ -263,11 +279,14 @@ export function createDoctorReport(config: AgentDispatchConfig): DoctorReport {
for (const [name, backend] of Object.entries(config.backends)) {
if (backend.adapter !== "aws-agentcore") continue;
const runtimeArn = optionalString(backend.details?.runtimeArn ?? process.env.AGENTDISPATCH_AGENTCORE_RUNTIME_ARN);
const hasPlaceholderRuntimeArn = runtimeArn === PLACEHOLDER_RUNTIME_ARN;
checks.push({
name: `backend.${name}.runtimeArn`,
status: runtimeArn ? "pass" : "warn",
status: runtimeArn && !hasPlaceholderRuntimeArn ? "pass" : "warn",
message: runtimeArn
? `AWS AgentCore backend ${name} has a runtime ARN for session mode.`
? hasPlaceholderRuntimeArn
? `AWS AgentCore backend ${name} still uses the sample placeholder runtimeArn; session mode dispatch will fail until a real ARN is configured.`
: `AWS AgentCore backend ${name} has a runtime ARN for session mode.`
: `AWS AgentCore backend ${name} has no runtimeArn; session mode dispatch will fail unless AGENTDISPATCH_AGENTCORE_RUNTIME_ARN is set.`
});
const account = config.accounts[backend.account];
Expand Down Expand Up @@ -308,13 +327,16 @@ function resolveRuntimeProfile(config: AgentDispatchConfig, runtimeName?: string
return profile;
}

async function waitForTask(client: AgentDispatchClient, taskId: string, pollIntervalMs: number, timeoutMs: number) {
async function waitForTask(client: AgentDispatchClient, taskId: string, pollIntervalMs: number, timeoutMs: number, output: CliOutput = console) {
const startedAt = Date.now();
let cursor = 0;
while (Date.now() - startedAt <= timeoutMs) {
const logs = await client.getTaskLogs(taskId, cursor);
cursor = logs.nextCursor;
if (logs.data) process.stdout.write(logs.data);
if (logs.data) {
if (output.write) output.write(logs.data);
else process.stdout.write(logs.data);
}
const task = await client.getTaskStatus(taskId);
if (isTerminal(task.status)) {
return client.getTaskResult(taskId);
Expand Down
33 changes: 33 additions & 0 deletions test/cli.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,20 @@ describe("agentdispatch CLI", () => {
expect(config.runtimes["research-agent"].backend).toBe("aws-agentcore");
});

it("does not write a fake runtime ARN when init omits one", async () => {
stateDir = await mkdtemp(join(tmpdir(), "agentdispatch-cli-"));
const configPath = join(stateDir, "agentdispatch.config.json");
const program = buildProgram({ log: () => undefined, error: () => undefined });

await program.parseAsync(["node", "agentdispatch", "init", "--config", configPath, "--region", "us-west-2"]);
const config = JSON.parse(await readFile(configPath, "utf8"));

expect(config.backends["aws-agentcore"].details.runtimeArn).toBeUndefined();
expect(createDoctorReport(config).checks).toEqual(expect.arrayContaining([
expect.objectContaining({ name: "backend.aws-agentcore.runtimeArn", status: "warn" })
]));
});

it("builds a provider-neutral sample config", () => {
expect(sampleConfig("us-east-1", "arn:runtime")).toMatchObject({
defaults: { runtime: "research-agent" }
Expand All @@ -51,6 +65,25 @@ describe("agentdispatch CLI", () => {
});
});

it("preserves runtime profile target mode when CLI option is omitted", () => {
const config = sampleConfig("us-east-1", "arn:runtime");
config.runtimes!["research-agent"].target = { mode: "runtime", details: { ecrImageUri: "image" } };

const request = createDispatchRequest(config, { instruction: "do work" });

expect(request.target).toEqual({ mode: "runtime", details: { ecrImageUri: "image" } });
});

it("rejects empty run payloads", () => {
expect(() => createDispatchRequest(sampleConfig("us-east-1", "arn:runtime"), {})).toThrow("Pass --instruction");
expect(() => createDispatchRequest(sampleConfig("us-east-1", "arn:runtime"), { taskType: "command.run" })).toThrow("Pass --command");
});

it("rejects ambiguous run payloads unless task type is explicit", () => {
expect(() => createDispatchRequest(sampleConfig("us-east-1", "arn:runtime"), { instruction: "do work", command: "echo hi" })).toThrow("Pass either");
expect(createDispatchRequest(sampleConfig("us-east-1", "arn:runtime"), { taskType: "command.run", instruction: "do work", command: "echo hi" }).taskType).toBe("command.run");
});

it("infers command.run and parses target details", () => {
const request = createDispatchRequest(sampleConfig("us-east-1", "arn:runtime"), {
command: "echo hello",
Expand Down
Loading