@polka-codes/cli 0.1.7 → 0.2.0
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 +39 -29
- package/dist/index.js +27698 -27299
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -1,11 +1,22 @@
|
|
|
1
|
-
# Polka Codes CLI
|
|
1
|
+
# Polka Codes CLI - Command Line Interface
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://bun.sh)
|
|
4
|
+
[](https://www.typescriptlang.org)
|
|
5
|
+
|
|
6
|
+
The Polka Codes CLI provides a powerful command-line interface for interacting with the Polka Codes AI coding assistant framework.
|
|
4
7
|
|
|
5
8
|
## Installation
|
|
6
9
|
|
|
10
|
+
### Global Installation
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install -g @polka-codes/cli
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
### Run Directly
|
|
17
|
+
|
|
7
18
|
```bash
|
|
8
|
-
|
|
19
|
+
npx @polka-codes/cli
|
|
9
20
|
```
|
|
10
21
|
|
|
11
22
|
## Usage
|
|
@@ -13,14 +24,11 @@ bun add @polka-codes/cli
|
|
|
13
24
|
### Basic Commands
|
|
14
25
|
|
|
15
26
|
```bash
|
|
16
|
-
# Run interactive
|
|
27
|
+
# Run interactive session
|
|
17
28
|
polka
|
|
18
29
|
|
|
19
30
|
# Run specific task
|
|
20
|
-
polka
|
|
21
|
-
|
|
22
|
-
# Show help
|
|
23
|
-
polka --help
|
|
31
|
+
polka task "improve readme"
|
|
24
32
|
```
|
|
25
33
|
|
|
26
34
|
### Configuration
|
|
@@ -28,36 +36,38 @@ polka --help
|
|
|
28
36
|
Create a `.polkacodes.yml` file in your project root:
|
|
29
37
|
|
|
30
38
|
```yaml
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
39
|
+
# Example configuration
|
|
40
|
+
provider: deepseek
|
|
41
|
+
modelId: deepseek-chat
|
|
42
|
+
commands: # a set of available commands for the AI assistant
|
|
43
|
+
check: bun check # command
|
|
44
|
+
test: # command name
|
|
45
|
+
command: bun test # command to execute
|
|
46
|
+
description: Run tests. Pass file path to run a specific test file. # description of the command
|
|
47
|
+
rules: |
|
|
48
|
+
Additional rules for the AI assistant.
|
|
37
49
|
```
|
|
38
50
|
|
|
39
|
-
###
|
|
51
|
+
### AI Configuration
|
|
40
52
|
|
|
41
|
-
|
|
42
|
-
- `list`: List available tasks
|
|
43
|
-
- `config`: Show current configuration
|
|
44
|
-
- `help`: Show help information
|
|
53
|
+
The default API provider is Ollama with 'maryasov/qwen2.5-coder-cline:7b' model.
|
|
45
54
|
|
|
46
|
-
|
|
55
|
+
Supported providers (in recommended order):
|
|
56
|
+
1. DeepSeek / `deepseek` (recommended)
|
|
57
|
+
2. Anthropic / `anthropic` (Sonnet 3.5 recommended)
|
|
58
|
+
3. Ollama / `ollama`
|
|
47
59
|
|
|
48
|
-
|
|
60
|
+
Configure the AI service by creating a `.env` file in your project root:
|
|
49
61
|
|
|
50
62
|
```bash
|
|
51
|
-
|
|
52
|
-
bun run build
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### Testing
|
|
63
|
+
POLKA_API_KEY=your_api_key_here
|
|
56
64
|
|
|
57
|
-
|
|
58
|
-
|
|
65
|
+
# Optional - override default model
|
|
66
|
+
POLKA_API_PROVIDER=deepseek # or anthropic, ollama
|
|
67
|
+
POLKA_AI_MODEL_ID=deepseek-chat # or claude-3-sonnet-20240229
|
|
59
68
|
```
|
|
60
69
|
|
|
61
70
|
---
|
|
62
71
|
|
|
63
|
-
|
|
72
|
+
|
|
73
|
+
*This README was generated by polka.codes*
|