learnhouse 1.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/LICENSE +661 -0
- package/README.md +103 -0
- package/dist/bin/learnhouse.js +6181 -0
- package/package.json +55 -0
package/README.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# LearnHouse CLI
|
|
2
|
+
|
|
3
|
+
Deploy and manage a self-hosted LearnHouse instance with a single command. Handles configuration, Docker, SSL, and database setup.
|
|
4
|
+
|
|
5
|
+
<img width="915" height="871" alt="image" src="https://github.com/user-attachments/assets/957c6cea-3efb-4cab-a643-55df3ac4c6aa" />
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
### One-line install
|
|
10
|
+
|
|
11
|
+
**macOS / Linux:**
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
curl -fsSL https://raw.githubusercontent.com/learnhouse/learnhouse/main/apps/cli/install.sh | bash
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
**Windows (PowerShell):**
|
|
18
|
+
|
|
19
|
+
```powershell
|
|
20
|
+
irm https://raw.githubusercontent.com/learnhouse/learnhouse/main/apps/cli/install.ps1 | iex
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
This installs Docker and Node.js if needed, then launches the CLI.
|
|
24
|
+
|
|
25
|
+
### If you already have Docker and Node.js
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npx learnhouse@latest
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Requirements
|
|
32
|
+
|
|
33
|
+
- **Node.js** >= 18
|
|
34
|
+
- **Docker** with Docker Compose v2
|
|
35
|
+
|
|
36
|
+
## Commands
|
|
37
|
+
|
|
38
|
+
| Command | Description |
|
|
39
|
+
|---------|-------------|
|
|
40
|
+
| `learnhouse setup` | Interactive setup wizard — domain, database, admin account, optional features |
|
|
41
|
+
| `learnhouse start` | Start all services |
|
|
42
|
+
| `learnhouse stop` | Stop all services |
|
|
43
|
+
| `learnhouse logs` | Stream logs from all containers (full history + follow) |
|
|
44
|
+
| `learnhouse config` | Show current configuration |
|
|
45
|
+
| `learnhouse backup` | Backup or restore the database |
|
|
46
|
+
| `learnhouse deployments` | View deployments and set resource limits |
|
|
47
|
+
| `learnhouse doctor` | Run diagnostics — checks Docker, containers, ports, DNS, disk, logs, env |
|
|
48
|
+
| `learnhouse shell` | Open an interactive shell in a running container |
|
|
49
|
+
|
|
50
|
+
## Setup Wizard
|
|
51
|
+
|
|
52
|
+
The setup wizard walks through:
|
|
53
|
+
|
|
54
|
+
1. **Install directory** — where files are generated
|
|
55
|
+
2. **Domain** — hostname, port, HTTPS/SSL configuration
|
|
56
|
+
3. **Database & Redis** — local (Docker) or external connection strings
|
|
57
|
+
4. **Organization** — name for your LearnHouse instance
|
|
58
|
+
5. **Admin account** — email and password
|
|
59
|
+
6. **Optional features** — AI (Gemini), email (Resend), S3 storage, Google OAuth, Unsplash
|
|
60
|
+
|
|
61
|
+
You can go back to any previous step during setup, and edit any step from the summary before confirming.
|
|
62
|
+
|
|
63
|
+
At the end, the wizard generates `docker-compose.yml`, `.env`, and proxy configs, then optionally starts everything.
|
|
64
|
+
|
|
65
|
+
## Managing Your Instance
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
# Start / stop
|
|
69
|
+
npx learnhouse start
|
|
70
|
+
npx learnhouse stop
|
|
71
|
+
|
|
72
|
+
# View logs
|
|
73
|
+
npx learnhouse logs
|
|
74
|
+
|
|
75
|
+
# Backup database
|
|
76
|
+
npx learnhouse backup
|
|
77
|
+
|
|
78
|
+
# Diagnose issues
|
|
79
|
+
npx learnhouse doctor
|
|
80
|
+
|
|
81
|
+
# Open a shell in a container
|
|
82
|
+
npx learnhouse shell
|
|
83
|
+
|
|
84
|
+
# Set memory limits
|
|
85
|
+
npx learnhouse deployments
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## What Gets Generated
|
|
89
|
+
|
|
90
|
+
After setup, your install directory contains:
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
learnhouse/
|
|
94
|
+
docker-compose.yml # Service definitions
|
|
95
|
+
.env # All configuration
|
|
96
|
+
learnhouse.config.json # CLI metadata
|
|
97
|
+
extra/
|
|
98
|
+
nginx.prod.conf # Nginx config (or Caddyfile for auto-SSL)
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## License
|
|
102
|
+
|
|
103
|
+
GPL-3.0
|