{{PACKAGE_NAME}}

Quick Start

Using with llmist CLI

# Use all gadgets
bunx @llmist/cli agent "your task" -g {{PACKAGE_NAME}}
# Use subagent preset (Explorer only)
bunx @llmist/cli agent "your task" -g {{PACKAGE_NAME}}:subagent
# Use readonly preset
bunx @llmist/cli agent "your task" -g {{PACKAGE_NAME}}:readonly
# Use from GitHub (before publishing to npm)
bunx @llmist/cli agent "your task" -g git+https://github.com/{{GITHUB_USER}}/{{PACKAGE_NAME}}.git

Configuration

[subagents.Explorer]
model = "sonnet" # Model for the explorer subagent
maxIterations = 20 # Maximum steps before giving up

Using in Projects

Installation

npm install {{PACKAGE_NAME}}
# or
bun add {{PACKAGE_NAME}}

Using the Subagent

import { LLMist } from 'llmist';
import { ExplorerSubagent } from '{{PACKAGE_NAME}}';
const result = await LLMist.createAgent()
 .withModel('sonnet')
 .withGadgets(new ExplorerSubagent())
 .askAndCollect('Explore this topic and report findings');
console.log(result.text);

Using Individual Gadgets

import { LLMist, AgentBuilder } from 'llmist';
import { exampleSearch, ExampleAction, SessionManager } from '{{PACKAGE_NAME}}';
// Function-based gadget (stateless)
const agent1 = new AgentBuilder(new LLMist())
 .withGadgets(exampleSearch)
 .ask('Search for something');
// Class-based gadget (with session manager)
const manager = new SessionManager();
const agent2 = new AgentBuilder(new LLMist())
 .withGadgets(new ExampleAction(manager))
 .ask('Perform an action');

Using Factory Functions

import { createGadgets, createGadgetsByPreset } from '{{PACKAGE_NAME}}';
// Create all gadgets
const gadgets = createGadgets();
agent.withGadgets(gadgets.ExampleSearch, gadgets.ExampleAction);
// Create by preset
const readonlyGadgets = createGadgetsByPreset('readonly');
agent.withGadgets(...readonlyGadgets);

Available Presets

Available Gadgets

Documentation

Development

# Install dependencies
bun install
# Run tests
bun test
# Type check
bun run typecheck
# Lint
bun run lint
# Build
bun run build
# Run all checks (pre-commit)
bun run precheck

Template Customization

Learn More

License