@compilr-dev/sdk 0.1.6 → 0.1.7
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/README.md +133 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# @compilr-dev/sdk
|
|
2
|
+
|
|
3
|
+
```
|
|
4
|
+
\|/
|
|
5
|
+
╭══════════╮ ___ ___ _ __ ___ _ __ (_) |_ __
|
|
6
|
+
║' ▐▌ ▐▌ │ / __|/ _ \| '_ ` _ \| '_ \| | | '__|
|
|
7
|
+
║ │ | (__| (_) | | | | | | |_) | | | |
|
|
8
|
+
╰─═──────═─╯ \___|\___/|_| |_| |_| .__/|_|_|_|
|
|
9
|
+
\________\ | | .dev
|
|
10
|
+
|_| sdk
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
> Universal agent runtime for building AI-powered applications
|
|
14
|
+
|
|
15
|
+
[](https://www.npmjs.com/package/@compilr-dev/sdk)
|
|
16
|
+
[](https://opensource.org/licenses/MIT)
|
|
17
|
+
|
|
18
|
+
## Overview
|
|
19
|
+
|
|
20
|
+
The SDK sits on top of [@compilr-dev/agents](https://www.npmjs.com/package/@compilr-dev/agents) and [@compilr-dev/agents-coding](https://www.npmjs.com/package/@compilr-dev/agents-coding), providing a high-level API for agent creation, tool assembly, and multi-agent teams. It's the runtime that powers [@compilr-dev/cli](https://www.npmjs.com/package/@compilr-dev/cli).
|
|
21
|
+
|
|
22
|
+
## Features
|
|
23
|
+
|
|
24
|
+
- **`createCompilrAgent()`** — three lines to a fully configured AI agent
|
|
25
|
+
- **`createTeam()`** — multi-agent teams with role identity and task handoff
|
|
26
|
+
- **Presets** — `coding` (40+ tools) and `read-only` out of the box
|
|
27
|
+
- **9 LLM Providers** — Claude, OpenAI, Gemini, Ollama, Together, Groq, Fireworks, Perplexity, OpenRouter
|
|
28
|
+
- **System Prompt Builder** — modular, token-aware prompt assembly
|
|
29
|
+
- **Full Re-exports** — use the SDK as your single dependency for the entire compilr-dev stack
|
|
30
|
+
|
|
31
|
+
## Installation
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm install @compilr-dev/sdk
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Peer dependencies:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm install @compilr-dev/agents @compilr-dev/agents-coding
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Quick Start
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
import { createCompilrAgent } from '@compilr-dev/sdk';
|
|
47
|
+
|
|
48
|
+
const agent = createCompilrAgent({
|
|
49
|
+
provider: { type: 'anthropic' },
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
const result = await agent.run('Fix the failing tests in src/auth/');
|
|
53
|
+
console.log(result.response);
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Custom Domain (Non-Coding)
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { createCompilrAgent, defineTool, createSuccessResult } from '@compilr-dev/sdk';
|
|
60
|
+
|
|
61
|
+
const agent = createCompilrAgent({
|
|
62
|
+
preset: 'none',
|
|
63
|
+
systemPrompt: 'You are an HR assistant.',
|
|
64
|
+
tools: {
|
|
65
|
+
custom: [
|
|
66
|
+
defineTool({
|
|
67
|
+
name: 'search_kb',
|
|
68
|
+
description: 'Search the knowledge base',
|
|
69
|
+
parameters: { query: { type: 'string' } },
|
|
70
|
+
execute: async ({ query }) => createSuccessResult(`Results for: ${query}`),
|
|
71
|
+
}),
|
|
72
|
+
],
|
|
73
|
+
},
|
|
74
|
+
});
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Multi-Agent Team
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
import { createTeam } from '@compilr-dev/sdk';
|
|
81
|
+
|
|
82
|
+
const team = createTeam({
|
|
83
|
+
agents: {
|
|
84
|
+
arch: { role: 'architect' },
|
|
85
|
+
dev: { role: 'developer' },
|
|
86
|
+
},
|
|
87
|
+
});
|
|
88
|
+
|
|
89
|
+
await team.run('Add rate limiting to the API');
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Supported Providers
|
|
93
|
+
|
|
94
|
+
| Provider | Type | Models |
|
|
95
|
+
|----------|------|--------|
|
|
96
|
+
| Anthropic | `anthropic` | Claude 4.5, Claude 4, Claude 3.5 |
|
|
97
|
+
| OpenAI | `openai` | GPT-4o, GPT-4, o1, o3 |
|
|
98
|
+
| Google | `gemini` | Gemini 2.5, Gemini 2.0 |
|
|
99
|
+
| Ollama | `ollama` | Any local model |
|
|
100
|
+
| Together AI | `together` | Llama, Qwen, DeepSeek |
|
|
101
|
+
| Groq | `groq` | Llama, Mixtral |
|
|
102
|
+
| Fireworks | `fireworks` | Llama, Qwen |
|
|
103
|
+
| Perplexity | `perplexity` | Sonar models |
|
|
104
|
+
| OpenRouter | `openrouter` | Multi-provider routing |
|
|
105
|
+
|
|
106
|
+
## Requirements
|
|
107
|
+
|
|
108
|
+
- Node.js >= 18
|
|
109
|
+
- Peer dependencies: `@compilr-dev/agents` ^0.3.14, `@compilr-dev/agents-coding` ^1.0.2
|
|
110
|
+
|
|
111
|
+
## Related Packages
|
|
112
|
+
|
|
113
|
+
| Package | Description |
|
|
114
|
+
|---------|-------------|
|
|
115
|
+
| [@compilr-dev/cli](https://www.npmjs.com/package/@compilr-dev/cli) | AI-powered coding assistant for your terminal |
|
|
116
|
+
| [@compilr-dev/agents](https://www.npmjs.com/package/@compilr-dev/agents) | Multi-LLM agent library |
|
|
117
|
+
| [@compilr-dev/agents-coding](https://www.npmjs.com/package/@compilr-dev/agents-coding) | Coding-specific tools and language analysis |
|
|
118
|
+
|
|
119
|
+
## Links
|
|
120
|
+
|
|
121
|
+
- [Website](https://compilr.dev)
|
|
122
|
+
- [npm Package](https://www.npmjs.com/package/@compilr-dev/sdk)
|
|
123
|
+
- [Report Issues](https://github.com/compilr-dev/sdk/issues)
|
|
124
|
+
|
|
125
|
+
## License
|
|
126
|
+
|
|
127
|
+
MIT - See [LICENSE](LICENSE) for details.
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
<p align="center">
|
|
132
|
+
<strong>Built with care by <a href="https://compilr.dev">compilr.dev</a></strong>
|
|
133
|
+
</p>
|