superacli 1.1.9 → 1.1.10
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/package.json +1 -1
- package/plugins/plugins.json +10 -0
- package/plugins/pplx/README.md +95 -0
- package/plugins/pplx/plugin.json +123 -0
- package/plugins/pplx/skills/usage/SKILL.md +121 -0
package/package.json
CHANGED
package/plugins/plugins.json
CHANGED
|
@@ -581,6 +581,16 @@
|
|
|
581
581
|
"type": "bundled",
|
|
582
582
|
"manifest_path": "plugins/boxlite/plugin.json"
|
|
583
583
|
}
|
|
584
|
+
},
|
|
585
|
+
{
|
|
586
|
+
"name": "pplx",
|
|
587
|
+
"description": "Perplexity API CLI for online search, research, and Q&A with citations",
|
|
588
|
+
"tags": ["perplexity", "ai", "search", "research", "llm", "citations", "online"],
|
|
589
|
+
"has_learn": true,
|
|
590
|
+
"source": {
|
|
591
|
+
"type": "bundled",
|
|
592
|
+
"manifest_path": "plugins/pplx/plugin.json"
|
|
593
|
+
}
|
|
584
594
|
}
|
|
585
595
|
]
|
|
586
596
|
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# pplx Plugin
|
|
2
|
+
|
|
3
|
+
Perplexity API CLI plugin for SuperCLI - Fast, non-interactive, agent-first CLI for online search and research with citations.
|
|
4
|
+
|
|
5
|
+
## Source
|
|
6
|
+
|
|
7
|
+
- **CLI Repository**: https://github.com/javimosch/pplx
|
|
8
|
+
- **Skill Sync**: Auto-syncs from `.agents/skills/pplx-usage/SKILL.md`
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
# Learn about the plugin
|
|
14
|
+
sc plugins learn pplx
|
|
15
|
+
|
|
16
|
+
# Install from registry
|
|
17
|
+
sc plugins install pplx
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Configuration
|
|
21
|
+
|
|
22
|
+
Set your Perplexity API key:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
export PERPLEXITY_API_KEY=pplx-xxxxxxxxxxxxxxxxxxxxxxxx
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Or use `--api-key` flag with each command.
|
|
29
|
+
|
|
30
|
+
Get API key: https://www.perplexity.ai/settings/api
|
|
31
|
+
|
|
32
|
+
## Commands
|
|
33
|
+
|
|
34
|
+
| Command | Description |
|
|
35
|
+
|---------|-------------|
|
|
36
|
+
| `sc pplx chat send <message>` | Send a chat completion request |
|
|
37
|
+
| `sc pplx ask send <question>` | Ask a question (simplified chat) |
|
|
38
|
+
| `sc pplx models list` | List available Perplexity models |
|
|
39
|
+
| `sc pplx help json` | Get machine-readable help schema |
|
|
40
|
+
| `sc pplx _ <any>` | Passthrough for any pplx command |
|
|
41
|
+
|
|
42
|
+
## Examples
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Quick question
|
|
46
|
+
sc pplx ask send "What is quantum computing?" --json
|
|
47
|
+
|
|
48
|
+
# Research with citations
|
|
49
|
+
sc pplx chat send "Latest AI developments 2025" --citations --json
|
|
50
|
+
|
|
51
|
+
# Deep research
|
|
52
|
+
sc pplx chat send "Climate change research" \
|
|
53
|
+
--model sonar-deep-research \
|
|
54
|
+
--citations \
|
|
55
|
+
--related-questions \
|
|
56
|
+
--json
|
|
57
|
+
|
|
58
|
+
# List models
|
|
59
|
+
sc pplx models list --json
|
|
60
|
+
|
|
61
|
+
# Passthrough mode
|
|
62
|
+
sc pplx _ chat "Question" --model sonar-pro --temperature 0.7
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Available Models
|
|
66
|
+
|
|
67
|
+
- `sonar` - Fast online search
|
|
68
|
+
- `sonar-pro` - Advanced online search
|
|
69
|
+
- `sonar-deep-research` - Deep research with citations
|
|
70
|
+
- `sonar-reasoning` - Reasoning with search
|
|
71
|
+
- `sonar-reasoning-pro` - Advanced reasoning
|
|
72
|
+
|
|
73
|
+
## Error Handling
|
|
74
|
+
|
|
75
|
+
| Exit Code | Type | Action |
|
|
76
|
+
|-----------|------|--------|
|
|
77
|
+
| 0 | success | Parse response |
|
|
78
|
+
| 85 | missing_api_key | Set PERPLEXITY_API_KEY |
|
|
79
|
+
| 87 | authentication_failed | Check API key |
|
|
80
|
+
| 106 | rate_limited | Wait 60s and retry |
|
|
81
|
+
| 105 | timeout | Retry immediately |
|
|
82
|
+
|
|
83
|
+
## Skills
|
|
84
|
+
|
|
85
|
+
This plugin includes learn skills:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
sc plugins learn pplx
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Skills are synced from the remote repository automatically.
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
MIT
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "pplx",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Perplexity API CLI - Fast, non-interactive, agent-first CLI for online search and research with citations",
|
|
5
|
+
"source": "https://github.com/javimosch/pplx",
|
|
6
|
+
"tags": ["perplexity", "ai", "search", "research", "llm", "citations"],
|
|
7
|
+
"has_learn": true,
|
|
8
|
+
"learn": {
|
|
9
|
+
"file": "skills/usage/SKILL.md",
|
|
10
|
+
"remote": {
|
|
11
|
+
"repo": "https://github.com/javimosch/pplx",
|
|
12
|
+
"path": ".agents/skills/pplx-usage/SKILL.md",
|
|
13
|
+
"sync": true
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"checks": [
|
|
17
|
+
{ "type": "binary", "name": "node" },
|
|
18
|
+
{ "type": "env", "name": "PERPLEXITY_API_KEY", "required": false }
|
|
19
|
+
],
|
|
20
|
+
"commands": [
|
|
21
|
+
{
|
|
22
|
+
"namespace": "pplx",
|
|
23
|
+
"resource": "chat",
|
|
24
|
+
"action": "send",
|
|
25
|
+
"description": "Send a chat completion request to Perplexity API",
|
|
26
|
+
"adapter": "process",
|
|
27
|
+
"adapterConfig": {
|
|
28
|
+
"command": "node",
|
|
29
|
+
"baseArgs": ["cli/bin/pplx.js", "chat"],
|
|
30
|
+
"positionalArgs": ["message"],
|
|
31
|
+
"jsonFlag": "--json",
|
|
32
|
+
"parseJson": true,
|
|
33
|
+
"missingDependencyHelp": "Set PERPLEXITY_API_KEY env var or use --api-key flag",
|
|
34
|
+
"pluginDir": "plugins/pplx"
|
|
35
|
+
},
|
|
36
|
+
"args": [
|
|
37
|
+
{ "name": "message", "type": "string", "required": true, "description": "The message to send" },
|
|
38
|
+
{ "name": "model", "type": "string", "required": false, "description": "Model to use (sonar, sonar-pro, sonar-deep-research, sonar-reasoning, sonar-reasoning-pro)", "flag": "--model", "default": "sonar" },
|
|
39
|
+
{ "name": "api-key", "type": "string", "required": false, "description": "API key override (overrides PERPLEXITY_API_KEY env var)", "flag": "--api-key" },
|
|
40
|
+
{ "name": "citations", "type": "boolean", "required": false, "description": "Return citations for verification", "flag": "--citations" },
|
|
41
|
+
{ "name": "images", "type": "boolean", "required": false, "description": "Return images", "flag": "--images" },
|
|
42
|
+
{ "name": "related-questions", "type": "boolean", "required": false, "description": "Return related questions", "flag": "--related-questions" },
|
|
43
|
+
{ "name": "search-queries", "type": "boolean", "required": false, "description": "Return search queries used", "flag": "--search-queries" },
|
|
44
|
+
{ "name": "system", "type": "string", "required": false, "description": "System prompt", "flag": "--system" },
|
|
45
|
+
{ "name": "temperature", "type": "number", "required": false, "description": "Temperature (0-1)", "flag": "--temperature" },
|
|
46
|
+
{ "name": "max-tokens", "type": "integer", "required": false, "description": "Maximum tokens in response", "flag": "--max-tokens" },
|
|
47
|
+
{ "name": "json", "type": "boolean", "required": false, "description": "Output in JSON format", "flag": "--json" }
|
|
48
|
+
]
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"namespace": "pplx",
|
|
52
|
+
"resource": "ask",
|
|
53
|
+
"action": "send",
|
|
54
|
+
"description": "Ask a question (simplified chat for Q&A)",
|
|
55
|
+
"adapter": "process",
|
|
56
|
+
"adapterConfig": {
|
|
57
|
+
"command": "node",
|
|
58
|
+
"baseArgs": ["cli/bin/pplx.js", "ask"],
|
|
59
|
+
"positionalArgs": ["question"],
|
|
60
|
+
"jsonFlag": "--json",
|
|
61
|
+
"parseJson": true,
|
|
62
|
+
"missingDependencyHelp": "Set PERPLEXITY_API_KEY env var or use --api-key flag",
|
|
63
|
+
"pluginDir": "plugins/pplx"
|
|
64
|
+
},
|
|
65
|
+
"args": [
|
|
66
|
+
{ "name": "question", "type": "string", "required": true, "description": "The question to ask" },
|
|
67
|
+
{ "name": "model", "type": "string", "required": false, "description": "Model to use", "flag": "--model", "default": "sonar" },
|
|
68
|
+
{ "name": "api-key", "type": "string", "required": false, "description": "API key override", "flag": "--api-key" },
|
|
69
|
+
{ "name": "citations", "type": "boolean", "required": false, "description": "Return citations", "flag": "--citations" },
|
|
70
|
+
{ "name": "system", "type": "string", "required": false, "description": "System prompt", "flag": "--system" },
|
|
71
|
+
{ "name": "json", "type": "boolean", "required": false, "description": "Output in JSON format", "flag": "--json" }
|
|
72
|
+
]
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"namespace": "pplx",
|
|
76
|
+
"resource": "models",
|
|
77
|
+
"action": "list",
|
|
78
|
+
"description": "List available Perplexity models",
|
|
79
|
+
"adapter": "process",
|
|
80
|
+
"adapterConfig": {
|
|
81
|
+
"command": "node",
|
|
82
|
+
"baseArgs": ["cli/bin/pplx.js", "models"],
|
|
83
|
+
"jsonFlag": "--json",
|
|
84
|
+
"parseJson": true,
|
|
85
|
+
"missingDependencyHelp": "Set PERPLEXITY_API_KEY env var or use --api-key flag",
|
|
86
|
+
"pluginDir": "plugins/pplx"
|
|
87
|
+
},
|
|
88
|
+
"args": [
|
|
89
|
+
{ "name": "api-key", "type": "string", "required": false, "description": "API key override", "flag": "--api-key" },
|
|
90
|
+
{ "name": "json", "type": "boolean", "required": false, "description": "Output in JSON format", "flag": "--json" }
|
|
91
|
+
]
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"namespace": "pplx",
|
|
95
|
+
"resource": "help",
|
|
96
|
+
"action": "json",
|
|
97
|
+
"description": "Get machine-readable help schema",
|
|
98
|
+
"adapter": "process",
|
|
99
|
+
"adapterConfig": {
|
|
100
|
+
"command": "node",
|
|
101
|
+
"baseArgs": ["cli/bin/pplx.js", "help-json"],
|
|
102
|
+
"parseJson": true,
|
|
103
|
+
"pluginDir": "plugins/pplx"
|
|
104
|
+
},
|
|
105
|
+
"args": []
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
"namespace": "pplx",
|
|
109
|
+
"resource": "_",
|
|
110
|
+
"action": "_",
|
|
111
|
+
"description": "Passthrough to execute any pplx CLI command directly",
|
|
112
|
+
"adapter": "process",
|
|
113
|
+
"adapterConfig": {
|
|
114
|
+
"command": "node",
|
|
115
|
+
"baseArgs": ["cli/bin/pplx.js"],
|
|
116
|
+
"passthrough": true,
|
|
117
|
+
"parseJson": false,
|
|
118
|
+
"pluginDir": "plugins/pplx"
|
|
119
|
+
},
|
|
120
|
+
"args": []
|
|
121
|
+
}
|
|
122
|
+
]
|
|
123
|
+
}
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
skill_name: "pplx_usage"
|
|
3
|
+
description: "Teaches agents how to use the Perplexity API CLI for online search, research, and Q&A with citations."
|
|
4
|
+
command: "sc skills get pplx.usage"
|
|
5
|
+
tags: ["perplexity", "ai", "search", "research", "llm", "citations", "online"]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# pplx Usage Skill
|
|
9
|
+
|
|
10
|
+
Use this skill when you need real-time information, research with citations, or online search capabilities through the Perplexity API.
|
|
11
|
+
|
|
12
|
+
## 1) Learn and Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
# Learn about the plugin
|
|
16
|
+
sc plugins learn pplx
|
|
17
|
+
|
|
18
|
+
# Install the plugin
|
|
19
|
+
sc plugins install pplx
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## 2) Configure API Key
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# Set environment variable (recommended)
|
|
26
|
+
export PERPLEXITY_API_KEY=pplx-xxxxxxxxxxxxxxxxxxxxxxxx
|
|
27
|
+
|
|
28
|
+
# Or use --api-key flag with each command
|
|
29
|
+
sc pplx chat send "Question" --api-key pplx-xxx
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Get API key: https://www.perplexity.ai/settings/api
|
|
33
|
+
|
|
34
|
+
## 3) Validate Setup
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
# Check version
|
|
38
|
+
sc pplx _ version
|
|
39
|
+
|
|
40
|
+
# List available models
|
|
41
|
+
sc pplx models list --json
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## 4) Common Workflows
|
|
45
|
+
|
|
46
|
+
### Quick Question
|
|
47
|
+
```bash
|
|
48
|
+
sc pplx ask send "What is quantum computing?" --json
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Research with Citations
|
|
52
|
+
```bash
|
|
53
|
+
sc pplx chat send "Latest developments in AI regulation 2025" --citations --json
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Deep Research
|
|
57
|
+
```bash
|
|
58
|
+
sc pplx chat send "Comprehensive analysis of renewable energy trends" \
|
|
59
|
+
--model sonar-deep-research \
|
|
60
|
+
--citations \
|
|
61
|
+
--related-questions \
|
|
62
|
+
--search-queries \
|
|
63
|
+
--json
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### List Models
|
|
67
|
+
```bash
|
|
68
|
+
sc pplx models list --json
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Get Help Schema
|
|
72
|
+
```bash
|
|
73
|
+
sc pplx help json
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## 5) Available Models
|
|
77
|
+
|
|
78
|
+
| Model | Use Case |
|
|
79
|
+
|-------|----------|
|
|
80
|
+
| `sonar` | Fast online search |
|
|
81
|
+
| `sonar-pro` | Advanced online search |
|
|
82
|
+
| `sonar-deep-research` | Deep research with citations |
|
|
83
|
+
| `sonar-reasoning` | Reasoning with search |
|
|
84
|
+
| `sonar-reasoning-pro` | Advanced reasoning |
|
|
85
|
+
|
|
86
|
+
## 6) Error Handling
|
|
87
|
+
|
|
88
|
+
Exit codes for agent decision-making:
|
|
89
|
+
|
|
90
|
+
| Code | Type | Action |
|
|
91
|
+
|------|------|--------|
|
|
92
|
+
| 0 | success | Parse response |
|
|
93
|
+
| 85 | missing_api_key | Set PERPLEXITY_API_KEY |
|
|
94
|
+
| 87 | authentication_failed | Check API key validity |
|
|
95
|
+
| 106 | rate_limited | Wait 60s and retry |
|
|
96
|
+
| 105 | timeout | Retry immediately |
|
|
97
|
+
|
|
98
|
+
## 7) Passthrough Mode
|
|
99
|
+
|
|
100
|
+
Use passthrough for advanced options:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
sc pplx _ chat "Question" --model sonar-pro --temperature 0.7 --max-tokens 500
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## 8) Remote Skill Sync
|
|
107
|
+
|
|
108
|
+
This plugin syncs skills from the remote repository:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
# Skills are auto-synced from https://github.com/javimosch/pplx
|
|
112
|
+
# Manual sync if needed:
|
|
113
|
+
sc skills sync pplx
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Caveats
|
|
117
|
+
|
|
118
|
+
- Always use `--json` for programmatic parsing
|
|
119
|
+
- API key required (env var or --api-key flag)
|
|
120
|
+
- Rate limits apply (exit code 106)
|
|
121
|
+
- Prefer `sonar-deep-research` for academic/research tasks
|