create-snipara 1.3.56 → 2.0.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 +19 -1
- package/dist/index.js +46 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ Use it for:
|
|
|
20
20
|
- Hosted MCP onboarding for Claude Code, Cursor, Windsurf, Codex, Gemini, Mistral, VS Code/Copilot, Continue, ChatGPT Desktop, and similar clients
|
|
21
21
|
- free account signup with reviewed Context + Memory
|
|
22
22
|
- local project wiring, `doctor`, `repair`, and `upgrade`
|
|
23
|
-
- GitHub repository sync and PR Answer Packs approval when the current folder is a GitHub repo
|
|
23
|
+
- local source activation without GitHub, plus optional GitHub repository sync and PR Answer Packs approval when the current folder is a GitHub repo
|
|
24
24
|
|
|
25
25
|
## Why It Exists
|
|
26
26
|
|
|
@@ -102,6 +102,7 @@ That distinction matters:
|
|
|
102
102
|
- opens the browser device-flow free Context + Memory account flow when needed
|
|
103
103
|
- writes Hosted MCP configuration
|
|
104
104
|
- detects a GitHub remote and can open the Snipara GitHub App automation path
|
|
105
|
+
- activates the current folder locally through `snipara-companion source init` so docs and code overlay context are available before GitHub approval
|
|
105
106
|
- explains the GitHub PR Answer Packs path for AI-assisted pull request workflows
|
|
106
107
|
- installs `snipara-companion` by default for local status, briefs, timelines,
|
|
107
108
|
phase commits, handoffs, resume, and managed workflows
|
|
@@ -129,6 +130,7 @@ That distinction matters:
|
|
|
129
130
|
Keep the package roles simple:
|
|
130
131
|
|
|
131
132
|
- `create-snipara` = connect the user to Hosted MCP Context + Memory
|
|
133
|
+
- `snipara-companion source init` = automatic local source snapshot, document dry-run, and local code overlay without GitHub
|
|
132
134
|
- `create-snipara --github` = connect the current GitHub repository through the browser approval flow for repository sync and PR Answer Packs
|
|
133
135
|
- `snipara-openclaw-install` = OpenClaw-only wrapper for Hosted MCP config plus OpenClaw env and hook setup
|
|
134
136
|
- `snipara-business` = prepare business context from local or mounted folders
|
|
@@ -190,6 +192,8 @@ the human-facing contract.
|
|
|
190
192
|
|
|
191
193
|
```bash
|
|
192
194
|
snipara-companion status
|
|
195
|
+
snipara-companion source init .
|
|
196
|
+
snipara-companion source sync --json
|
|
193
197
|
snipara-companion brief --task "ship auth hardening" --changed-files src/auth.ts
|
|
194
198
|
snipara-companion workflow start --goal "ship auth hardening" --plan-file ./plan.json
|
|
195
199
|
snipara-companion workflow phase-start context
|
|
@@ -206,6 +210,20 @@ snipara-companion workflow run --mode full --include-session-context --query "im
|
|
|
206
210
|
snipara-companion final-commit --summary "Shipped auth hardening and tests" --files src/auth.ts tests/auth.test.ts
|
|
207
211
|
```
|
|
208
212
|
|
|
213
|
+
### Local source first
|
|
214
|
+
|
|
215
|
+
For free users, the first useful source step does not need GitHub approval:
|
|
216
|
+
|
|
217
|
+
```bash
|
|
218
|
+
snipara-companion source init .
|
|
219
|
+
snipara-companion source status --json
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
That creates `.snipara/source/latest.json`, previews supported document sync,
|
|
223
|
+
and refreshes `.snipara/code-overlay/latest.json` from local files. GitHub
|
|
224
|
+
automation is still the canonical hosted repository path for teams, PR Answer
|
|
225
|
+
Packs, and shared CODE indexing after the user approves the provider.
|
|
226
|
+
|
|
209
227
|
## Main Commands
|
|
210
228
|
|
|
211
229
|
### Install or initialize
|
package/dist/index.js
CHANGED
|
@@ -13,7 +13,7 @@ import { homedir } from "os";
|
|
|
13
13
|
// package.json
|
|
14
14
|
var package_default = {
|
|
15
15
|
name: "create-snipara",
|
|
16
|
-
version: "
|
|
16
|
+
version: "2.0.0",
|
|
17
17
|
description: "Onboard Snipara Hosted MCP Context + Memory with auth, companion workflows, and optional Snipara Sandbox",
|
|
18
18
|
main: "dist/index.js",
|
|
19
19
|
type: "module",
|
|
@@ -90,7 +90,7 @@ var API_URL = "https://api.snipara.com";
|
|
|
90
90
|
var COMPANION_PACKAGE_NAME = "snipara-companion";
|
|
91
91
|
var COMPANION_COMMAND_NAME = "snipara-companion";
|
|
92
92
|
var COMPANION_NPX_COMMAND = "npx -y snipara-companion@latest";
|
|
93
|
-
var MIN_COMPANION_VERSION = "
|
|
93
|
+
var MIN_COMPANION_VERSION = "3.0.0";
|
|
94
94
|
var GITHUB_ANSWER_PACKS_LABEL = "GitHub PR Answer Packs";
|
|
95
95
|
var MCP_PACKAGE_NAME = "snipara-mcp";
|
|
96
96
|
var SANDBOX_PACKAGE_NAME = "snipara-sandbox[all]";
|
|
@@ -529,6 +529,7 @@ function printBanner() {
|
|
|
529
529
|
\u2551 \u2551
|
|
530
530
|
\u2551 \u2022 Hosted MCP for LLM agents \u2551
|
|
531
531
|
\u2551 \u2022 Free account path with hosted context and reviewed memory \u2551
|
|
532
|
+
\u2551 \u2022 Local source activation before GitHub approval \u2551
|
|
532
533
|
\u2551 \u2022 API / SDK for product integrations \u2551
|
|
533
534
|
\u2551 \u2022 Optional local companion and Snipara Sandbox helpers \u2551
|
|
534
535
|
\u2551 \u2022 One CLI for auth, config, doctor, repair, and upgrade \u2551
|
|
@@ -2228,6 +2229,24 @@ function getClientGuidance(client) {
|
|
|
2228
2229
|
function getCompanionCommands(answers) {
|
|
2229
2230
|
const projectFlag = answers.projectSlug ? ` --project ${answers.projectSlug}` : "";
|
|
2230
2231
|
const clientFlag = getCompanionInitClientFlag(answers.aiClient);
|
|
2232
|
+
const localSourceCommands = answers.installCompanion ? [
|
|
2233
|
+
{
|
|
2234
|
+
title: "Activate this folder locally",
|
|
2235
|
+
command: `${COMPANION_NPX_COMMAND} source init .`,
|
|
2236
|
+
purpose: "Create a local source snapshot, preview supported document sync, and build a local code overlay without GitHub."
|
|
2237
|
+
},
|
|
2238
|
+
{
|
|
2239
|
+
title: "Refresh local source context",
|
|
2240
|
+
command: `${COMPANION_NPX_COMMAND} source sync --json`,
|
|
2241
|
+
purpose: "Refresh the local snapshot, document dry-run, and code overlay cache after files change."
|
|
2242
|
+
}
|
|
2243
|
+
] : [
|
|
2244
|
+
{
|
|
2245
|
+
title: "Enable local source activation",
|
|
2246
|
+
command: "npx create-snipara repair --with-companion",
|
|
2247
|
+
purpose: `Install ${COMPANION_PACKAGE_NAME} so this project can run ${COMPANION_NPX_COMMAND} source init without GitHub.`
|
|
2248
|
+
}
|
|
2249
|
+
];
|
|
2231
2250
|
const businessOnboardingCommands = answers.installCompanion ? [
|
|
2232
2251
|
{
|
|
2233
2252
|
title: "Preview a business folder import",
|
|
@@ -2271,6 +2290,7 @@ function getCompanionCommands(answers) {
|
|
|
2271
2290
|
command: "create-snipara repair",
|
|
2272
2291
|
purpose: "Rebuild config files, hooks, and the companion pack."
|
|
2273
2292
|
},
|
|
2293
|
+
...localSourceCommands,
|
|
2274
2294
|
{
|
|
2275
2295
|
title: "Run a focused hosted query",
|
|
2276
2296
|
command: `${COMPANION_NPX_COMMAND} query --query "how does auth middleware work?" --max-tokens 4000`,
|
|
@@ -2527,7 +2547,29 @@ Apply only after reviewing the manifest:
|
|
|
2527
2547
|
|
|
2528
2548
|
\`npx create-snipara repair --with-companion\``}
|
|
2529
2549
|
|
|
2530
|
-
|
|
2550
|
+
## Local Source Activation
|
|
2551
|
+
|
|
2552
|
+
Use this first when the user has not connected GitHub yet, or when the folder has no Git metadata.
|
|
2553
|
+
It creates a local source snapshot, previews supported document sync, and refreshes the local code
|
|
2554
|
+
overlay cache that agents can query immediately.
|
|
2555
|
+
|
|
2556
|
+
${answers.installCompanion ? `Activate the current folder:
|
|
2557
|
+
|
|
2558
|
+
\`${COMPANION_NPX_COMMAND} source init .\`
|
|
2559
|
+
|
|
2560
|
+
Refresh after file changes:
|
|
2561
|
+
|
|
2562
|
+
\`${COMPANION_NPX_COMMAND} source sync --json\`
|
|
2563
|
+
|
|
2564
|
+
Inspect local drift:
|
|
2565
|
+
|
|
2566
|
+
\`${COMPANION_NPX_COMMAND} source status --json\`` : `This setup did not install snipara-companion. Enable it before local source activation:
|
|
2567
|
+
|
|
2568
|
+
\`npx create-snipara repair --with-companion\``}
|
|
2569
|
+
|
|
2570
|
+
GitHub automation remains useful after first value: it gives Snipara a canonical hosted repository
|
|
2571
|
+
sync and PR Answer Packs. Local source activation is the fallback, not a replacement for explicit
|
|
2572
|
+
provider approval when a team wants shared hosted code context.
|
|
2531
2573
|
|
|
2532
2574
|
## GitHub PR Answer Packs
|
|
2533
2575
|
|
|
@@ -3320,6 +3362,7 @@ function printSuccess(answers, report) {
|
|
|
3320
3362
|
printNextStep(
|
|
3321
3363
|
`${COMPANION_COMMAND_NAME} ${MIN_COMPANION_VERSION}+ is installed for low-latency local hooks.`
|
|
3322
3364
|
);
|
|
3365
|
+
printNextStep(`Activate local source context now with: ${COMPANION_NPX_COMMAND} source init .`);
|
|
3323
3366
|
printNextStep(
|
|
3324
3367
|
`Use ${COMPANION_NPX_COMMAND} recall / query / plan / upload / task-commit for explicit local workflows and as a fallback when an AI client exposes only a partial MCP surface.`
|
|
3325
3368
|
);
|
package/package.json
CHANGED