@starlight-ai/discord-waifus 0.1.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 ADDED
@@ -0,0 +1,49 @@
1
+ # @starlight-ai/discord-waifus
2
+
3
+ `@starlight-ai/discord-waifus` provides the global `waifus` command for the local Discord Waifus stack.
4
+
5
+ ## Install
6
+
7
+ After publication:
8
+
9
+ ```bash
10
+ pnpm add -g @starlight-ai/discord-waifus
11
+ ```
12
+
13
+ From a clone:
14
+
15
+ ```bash
16
+ pnpm --filter @starlight-ai/discord-waifus build
17
+ pnpm --filter @starlight-ai/discord-waifus link --global
18
+ ```
19
+
20
+ ## Typical Flow
21
+
22
+ ### Existing clone
23
+
24
+ ```bash
25
+ waifus use /path/to/Discord-Waifus
26
+ waifus init-config
27
+ waifus build
28
+ waifus start
29
+ waifus open
30
+ ```
31
+
32
+ ### Download from GitHub first
33
+
34
+ ```bash
35
+ waifus init ~/Discord-Waifus --repo https://github.com/<owner>/<repo>
36
+ waifus build
37
+ waifus init-config
38
+ waifus start
39
+ waifus open
40
+ ```
41
+
42
+ `waifus init` downloads the GitHub repository archive into a fresh target directory, saves that directory as the default project root, and runs `pnpm install` by default.
43
+
44
+ ## Runtime Model
45
+
46
+ - committed defaults live in `defaults/`
47
+ - local runtime state lives in `.waifus/`
48
+
49
+ This CLI is for local-machine usage. The dashboard runs on `http://localhost:3000` and the backend API runs on `http://127.0.0.1:4000`.
@@ -0,0 +1 @@
1
+ #!/usr/bin/env node