Skip to content

Quick Start

Terminal window
# One-shot: give it a task
npx agntk "organize this folder by file type"
# Named agent: remembers context across sessions
npx agntk -n coder "refactor the auth module to use JWT"
# Interactive REPL
npx agntk -n coder -i
# Pipe input
cat error.log | npx agntk "explain these errors and suggest fixes"
# List your agents
npx agntk list
# Inspect or manage an agent
npx agntk info coder
npx agntk clean

That’s it. No config files. No API key setup (unless you want to). It reads your files, runs commands, browses the web, spawns sub-agents, and remembers what it learns.

After any one-shot prompt, you can type follow-up messages directly — the agent stays in the terminal and remembers the conversation. Use -q to disable this and exit immediately.


Custom Tools

const agent = createAgent({
name: 'my-agent',
tools: {
myCustomTool: {
description: 'Does something custom',
parameters: z.object({ input: z.string() }),
execute: async ({ input }) => ({ output: `Processed: ${input}` }),
},
},
});

Custom tools are merged with the 20+ built-in tools.

  • SDK Core — Full agent configuration reference
  • CLI — Use agents from the command line
  • Configuration — Configuration system