superlore-cli 0.1.0 → 0.1.2
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 +42 -40
- package/dist/index.d.ts +1 -1
- package/dist/index.js +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,75 +1,77 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
1
3
|
# superlore-cli
|
|
2
4
|
|
|
3
|
-
The command
|
|
4
|
-
base your agents run on.** Scaffold, run, and build an agent-native KB authored in MDX, where
|
|
5
|
-
humans get a clean visual site and agents read the same content over **MCP**.
|
|
5
|
+
**The command companion your agents drive to build a knowledge base.**
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Scaffold the project, write the config, seed pages, wire the MCP, run the build — `superlore-cli`
|
|
8
|
+
is the hands your agent uses to turn _"make me a docs site"_ into a real, MCP-native KB. You can
|
|
9
|
+
drive it yourself, too.
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
_One corpus. Humans and agents._
|
|
10
12
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
14
16
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
+
## Let your agent do it
|
|
18
|
+
|
|
19
|
+
Install the superlore Claude plugin:
|
|
20
|
+
|
|
21
|
+
```text
|
|
22
|
+
/plugin marketplace add KrishnanSG/superlore
|
|
23
|
+
/plugin install superlore@superlore
|
|
17
24
|
```
|
|
18
25
|
|
|
19
|
-
|
|
26
|
+
Then just ask:
|
|
20
27
|
|
|
21
|
-
|
|
28
|
+
```text
|
|
29
|
+
Make me a docs site with superlore
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Your agent runs `superlore` under the hood — scaffolds the app, writes `superlore.json`, seeds a
|
|
33
|
+
page or two, mounts the MCP route, and previews it. You watch it happen. Then keep talking:
|
|
34
|
+
_"add an onboarding page"_, _"diagram our architecture"_, _"draft the Q3 roadmap."_
|
|
35
|
+
|
|
36
|
+
## Or drive it yourself
|
|
22
37
|
|
|
23
38
|
```bash
|
|
24
|
-
|
|
25
|
-
cd my-kb
|
|
26
|
-
superlore dev # local preview at http://localhost:3000
|
|
27
|
-
superlore build # production build (Next.js — deploy anywhere)
|
|
39
|
+
curl -fsSL https://superlore.vercel.app/install.sh | sh # or: npm i -g superlore-cli
|
|
28
40
|
```
|
|
29
41
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
42
|
+
```bash
|
|
43
|
+
superlore init my-kb # scaffold — 2 questions → superlore.json + starter pages
|
|
44
|
+
superlore dev # live preview at localhost:3000
|
|
45
|
+
superlore build # production build, deploy anywhere
|
|
46
|
+
```
|
|
35
47
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
| `superlore init [dir]` | Scaffold a new KB. Flags: `--name`, `--type <company-kb\|product-docs>`, `--auth` / `--no-auth`, `--allowed-domain <domain>`, `--accent <color>`, `--no-mcp`, `-y, --yes`. |
|
|
39
|
-
| `superlore dev` | Run the local site for preview (`--port`). |
|
|
40
|
-
| `superlore build` | Production build of the KB. |
|
|
41
|
-
| `superlore deploy` | Managed deploy via **superlore Cloud** — currently waitlisted; self-host free with `superlore build`. |
|
|
48
|
+
`superlore deploy` is reserved for managed **superlore Cloud**
|
|
49
|
+
([waitlisted](https://superlore.vercel.app/cloud)) — self-host free with `superlore build`.
|
|
42
50
|
|
|
43
51
|
## `superlore.json`
|
|
44
52
|
|
|
45
|
-
`init` writes
|
|
46
|
-
`superlore` package both read:
|
|
53
|
+
`init` writes one config the CLI, the site, and your agents all read:
|
|
47
54
|
|
|
48
55
|
```json
|
|
49
56
|
{
|
|
50
57
|
"name": "Acme Knowledge Base",
|
|
51
58
|
"type": "company-kb",
|
|
52
|
-
"accent": "#6D5CF0",
|
|
53
59
|
"auth": { "enabled": true, "provider": "google", "allowedDomain": "acme.com" },
|
|
54
60
|
"mcp": { "enabled": true, "path": "/api/mcp" }
|
|
55
61
|
}
|
|
56
62
|
```
|
|
57
63
|
|
|
58
|
-
- **`type`** — `company-kb` (internal, for your teams + agents) or `product-docs` (public
|
|
59
|
-
|
|
60
|
-
- **`auth`** — optional Google SSO that gates the site **and** the MCP. A company KB without auth
|
|
61
|
-
is warned about before deploy.
|
|
64
|
+
- **`type`** — `company-kb` (internal, for your teams + agents) or `product-docs` (public).
|
|
65
|
+
- **`auth`** — optional Google SSO that gates the site **and** the MCP.
|
|
62
66
|
- **`mcp`** — the agent endpoint, on by default at `/api/mcp`.
|
|
63
67
|
|
|
64
|
-
|
|
68
|
+
Need the schema in code? `import { parseSuperloreJson } from "superlore-cli/config"`.
|
|
65
69
|
|
|
66
70
|
## Links
|
|
67
71
|
|
|
68
|
-
|
|
69
|
-
- **Core library:** [`superlore`](https://www.npmjs.com/package/superlore)
|
|
70
|
-
- **Repository:** https://github.com/KrishnanSG/superlore
|
|
72
|
+
**[Docs](https://superlore.vercel.app/docs)** · **[`superlore` core](https://www.npmjs.com/package/superlore)** · **[GitHub](https://github.com/KrishnanSG/superlore)**
|
|
71
73
|
|
|
72
74
|
## License
|
|
73
75
|
|
|
74
|
-
[Apache-2.0](./LICENSE) © [Krishnan S G](https://github.com/KrishnanSG).
|
|
75
|
-
|
|
76
|
+
[Apache-2.0](./LICENSE) © [Krishnan S G](https://github.com/KrishnanSG). Bundled dependencies retain
|
|
77
|
+
their own licenses — see [`NOTICE`](./NOTICE).
|
package/dist/index.d.ts
CHANGED
|
@@ -83,7 +83,7 @@ declare function serializeSuperloreJson(config: SuperloreJson): string;
|
|
|
83
83
|
declare function resolveMcpPath(config: SuperloreJson): string | undefined;
|
|
84
84
|
|
|
85
85
|
/** The CLI version, kept in sync with package.json at build time. */
|
|
86
|
-
declare const VERSION = "0.1.
|
|
86
|
+
declare const VERSION = "0.1.2";
|
|
87
87
|
/** Build the argument parser. Exported for tests; `run()` wires it to argv. */
|
|
88
88
|
declare function buildCli(argv?: readonly string[]): cac.CAC;
|
|
89
89
|
/** Parse argv and dispatch. Reports unknown commands and unexpected errors cleanly. */
|
package/dist/index.js
CHANGED
|
@@ -25,12 +25,12 @@ function banner() {
|
|
|
25
25
|
process.stdout.write("superlore \u2014 the company knowledge base your agents run on.\n");
|
|
26
26
|
return;
|
|
27
27
|
}
|
|
28
|
-
const
|
|
28
|
+
const seam = dim("\u258F");
|
|
29
29
|
const lines = [
|
|
30
|
-
` ${
|
|
31
|
-
` ${
|
|
32
|
-
` ${
|
|
33
|
-
` ${
|
|
30
|
+
` ${accent("\u2597\u259F\u2588")}${accentSoft("\u2599\u2596")}`,
|
|
31
|
+
` ${accent("\u2590\u2588")}${seam}${accentSoft("\u2592\u258C")} ${wordmark("superlore")}`,
|
|
32
|
+
` ${accent("\u2590\u2588")}${seam}${accentSoft("\u2592\u258C")} ${dim("the company knowledge base your agents run on")}`,
|
|
33
|
+
` ${accent("\u259D\u259C\u2588")}${accentSoft("\u259B\u2598")}`
|
|
34
34
|
];
|
|
35
35
|
process.stdout.write(`
|
|
36
36
|
${lines.join("\n")}
|
|
@@ -829,7 +829,7 @@ function printNextSteps(root, config) {
|
|
|
829
829
|
}
|
|
830
830
|
|
|
831
831
|
// src/index.ts
|
|
832
|
-
var VERSION = "0.1.
|
|
832
|
+
var VERSION = "0.1.2";
|
|
833
833
|
function buildCli(argv = process2.argv) {
|
|
834
834
|
const cli = cac("superlore");
|
|
835
835
|
cli.command("init [dir]", "Scaffold a new superlore knowledge base").option("--name <name>", "KB name").option("--type <type>", "KB type: company-kb | product-docs").option("--auth", "Enable the Google SSO auth gate").option("--no-auth", "Disable the auth gate").option("--allowed-domain <domain>", "Restrict SSO to one email domain (implies --auth)").option("--accent <color>", "Brand accent colour (any CSS colour)").option("--no-mcp", "Disable the MCP endpoint (on by default)").option("-y, --yes", "Skip prompts; use flags + defaults").example("superlore init my-kb --type product-docs").example("superlore init acme --type company-kb --auth --allowed-domain acme.com").action(
|
package/package.json
CHANGED