@squidcloud/cli 1.0.483 → 1.0.485
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.
|
@@ -35,6 +35,17 @@ Squid is a backend-as-a-service platform that provides:
|
|
|
35
35
|
- **Integrations** → See `squid-integrations` skill for full catalog, connector AI functions, SDK methods, and configuration
|
|
36
36
|
- **React Hooks** → See `squid-react-development` skill
|
|
37
37
|
|
|
38
|
+
## Console vs SDK for Admin Actions
|
|
39
|
+
|
|
40
|
+
Some actions — creating an app, creating an integration/connector, generating API keys, managing secrets — are done in the [Squid Console](https://console.getsquid.ai/). Most of them can also be done with the SDK, but the Console is the better option in most cases, so refer the user there first while offering the SDK path as an alternative:
|
|
41
|
+
|
|
42
|
+
- **Creating orgs/apps:** `ManagementClient` with a management API key (Console → Profile Settings → API Keys, format `squid_mgmt_<uuid>`). See [admin.md](reference/admin.md).
|
|
43
|
+
- **Creating integrations/connectors, managing secrets:** `squid.admin()` — requires the app's admin API key, which the user can generate in the Console, plus the app's `.env` details (`SQUID_APP_ID`, `SQUID_REGION`, `SQUID_ENVIRONMENT_ID`, `SQUID_API_KEY`). See [console.md](reference/console.md) for Console ↔ SDK equivalents.
|
|
44
|
+
|
|
45
|
+
## Documentation Fallback
|
|
46
|
+
|
|
47
|
+
If a topic is not covered by this skill or its reference files, consult the official Squid documentation at https://docs.getsquid.ai — it covers many additional topics in depth.
|
|
48
|
+
|
|
38
49
|
## Architecture
|
|
39
50
|
|
|
40
51
|
### Components
|
|
@@ -80,6 +80,9 @@ Integrations are configured in **Squid Console** (recommended) or via the **IAC
|
|
|
80
80
|
### IAC API Setup (Programmatic)
|
|
81
81
|
See [integration-setup.md](reference/integration-setup.md) for programmatic setup via the IAC REST API.
|
|
82
82
|
|
|
83
|
+
### When helping a user create an integration
|
|
84
|
+
Refer the user to the Console first — it is the better option in most cases. Also offer to create the integration for them using the Squid SDK (`squid.admin().integrations().upsertIntegration(...)`); for that you need the app's admin API key, which the user can generate in the Console, plus the app's `.env` details (`SQUID_APP_ID`, `SQUID_REGION`, `SQUID_ENVIRONMENT_ID`, `SQUID_API_KEY`).
|
|
85
|
+
|
|
83
86
|
## Feature-Specific Guidance
|
|
84
87
|
|
|
85
88
|
- **[connector-sdks.md](reference/connector-sdks.md)** -> Connector client SDK packages and typed methods for direct use: @squidcloud/slack-client, @squidcloud/jira-client, @squidcloud/jira-jsm-client, @squidcloud/github-client, @squidcloud/salesforce-client, @squidcloud/freshdesk-client, @squidcloud/linear-client, @squidcloud/mail-client, @squidcloud/google-calendar-client, @squidcloud/google-drive-client, @squidcloud/servicenow_csm-client, @squidcloud/teams-client, @squidcloud/sharepoint-client, SquidSlackClient, SquidJiraClient, SquidGitHubClient, SquidSalesforceClient, FreshdeskClient, SquidLinearClient, SquidMailClient, sendMessage, searchIssues, createIssue, sendMail, searchPullRequests, createPullRequest, getOpportunity, createCase, searchTickets, executeFunction
|
|
@@ -241,6 +244,10 @@ class MyService extends SquidService {
|
|
|
241
244
|
}
|
|
242
245
|
```
|
|
243
246
|
|
|
247
|
+
## Documentation Fallback
|
|
248
|
+
|
|
249
|
+
If a topic is not covered by this skill or its reference files, consult the official Squid documentation at https://docs.getsquid.ai — it covers many additional topics in depth.
|
|
250
|
+
|
|
244
251
|
## Links
|
|
245
252
|
|
|
246
253
|
- Docs: https://docs.getsquid.ai/
|
|
@@ -19,6 +19,8 @@ This skill provides comprehensive, code-verified knowledge about developing Reac
|
|
|
19
19
|
|
|
20
20
|
**IMPORTANT:** Never invoke LLMs directly (e.g., importing `openai` or `@anthropic-ai/sdk`). Use Squid AI hooks (`useAiAgent`, `useAiChat`) or `squid.ai().agent()`. For external service integrations (email, Slack, Jira, etc.), use Squid's built-in integrations - see `squid-integrations` skill.
|
|
21
21
|
|
|
22
|
+
**Documentation fallback:** If a topic is not covered by this skill or the related Squid skills, consult the official Squid documentation at https://docs.getsquid.ai — it covers many additional topics in depth.
|
|
23
|
+
|
|
22
24
|
## Installation
|
|
23
25
|
|
|
24
26
|
```bash
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@squidcloud/cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.485",
|
|
4
4
|
"description": "The Squid CLI",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"node": ">=18.0.0"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@squidcloud/local-backend": "^1.0.
|
|
31
|
+
"@squidcloud/local-backend": "^1.0.485",
|
|
32
32
|
"adm-zip": "^0.5.16",
|
|
33
33
|
"copy-webpack-plugin": "^14.0.0",
|
|
34
34
|
"decompress": "^4.2.1",
|