starpak 0.1.2 → 0.1.3
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 +63 -0
- package/README.zh.md +63 -0
- package/package.json +4 -3
package/README.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# starpak ✨
|
|
2
|
+
|
|
3
|
+
> Universal package manager, but not just packages!
|
|
4
|
+
|
|
5
|
+
[中文文档](./README.zh.md)
|
|
6
|
+
|
|
7
|
+
**starpak** is an intent-driven universal deployment tool. One command turns any code (local project, GitHub repo, system package) into a running service.
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
cd ./my-project && starpak install # install deps
|
|
11
|
+
starpak start # run it
|
|
12
|
+
starpak stop # stop it
|
|
13
|
+
starpak enable # systemd auto-start
|
|
14
|
+
starpak build # compile
|
|
15
|
+
starpak search <query> # search GitHub repos
|
|
16
|
+
starpak install -s nginx # install system package
|
|
17
|
+
starpak test install # dry-run install
|
|
18
|
+
starpak remove me # uninstall starpak itself
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## How it works
|
|
22
|
+
|
|
23
|
+
1. **Smart detection** — reads project files (package.json, Makefile, Cargo.toml, go.mod, etc.), identifies runtime and build system
|
|
24
|
+
2. **Auto install** — installs deps, runs build, no manual config
|
|
25
|
+
3. **Zero-config start** — `cd` into the project and `starpak start`, it just works
|
|
26
|
+
4. **Multi-project** — detects frontend + backend separation, starts all sub-projects
|
|
27
|
+
5. **Startup scripts** — prioritizes `start.sh` / `run.sh` over default entry points
|
|
28
|
+
|
|
29
|
+
## Install
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm install -g starpak
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Commands
|
|
36
|
+
|
|
37
|
+
| Command | Description |
|
|
38
|
+
|---------|-------------|
|
|
39
|
+
| `install [target]` | Install dependencies for the project |
|
|
40
|
+
| `install -s <pkg>` | Install a system package via apt |
|
|
41
|
+
| `start` | Start the project in current directory |
|
|
42
|
+
| `stop` | Stop the project |
|
|
43
|
+
| `restart` | Restart the project |
|
|
44
|
+
| `enable` | Configure systemd auto-start |
|
|
45
|
+
| `disable` | Disable systemd auto-start |
|
|
46
|
+
| `status` | Check running status |
|
|
47
|
+
| `logs` | View process logs |
|
|
48
|
+
| `build [target]` | Build the project |
|
|
49
|
+
| `build -r` | Rebuild (clean + build) |
|
|
50
|
+
| `remove -s <pkg>` | Remove a system package |
|
|
51
|
+
| `search <query>` | Search GitHub repositories |
|
|
52
|
+
| `test install` | Dry-run install (show detection without executing) |
|
|
53
|
+
|
|
54
|
+
## Philosophy
|
|
55
|
+
|
|
56
|
+
- **cd in, the rest is automatic** — one command is all you need
|
|
57
|
+
- **No database, no tracking** — lives in your project directory, like npm
|
|
58
|
+
- **Adapt, don't replace** — stands on top of apt/npm/make/systemd, doesn't reinvent them
|
|
59
|
+
- **Easter egg** — `starpak remove me` uninstalls itself
|
|
60
|
+
|
|
61
|
+
## License
|
|
62
|
+
|
|
63
|
+
Apache-2.0
|
package/README.zh.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# starpak ✨
|
|
2
|
+
|
|
3
|
+
> 全能的包管理，但不只是管理包！
|
|
4
|
+
|
|
5
|
+
[English](./README.md)
|
|
6
|
+
|
|
7
|
+
**starpak** 是一个意图驱动的万能部署工具。一个命令就能把任何代码变成运行中的服务。
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
cd ./my-project && starpak install # 安装依赖
|
|
11
|
+
starpak start # 启动项目
|
|
12
|
+
starpak stop # 停止项目
|
|
13
|
+
starpak enable # 配置 systemd 开机自启
|
|
14
|
+
starpak build # 构建项目
|
|
15
|
+
starpak search <关键词> # 搜索 GitHub 仓库
|
|
16
|
+
starpak install -s nginx # 安装系统包
|
|
17
|
+
starpak test install # 模拟安装（不真执行）
|
|
18
|
+
starpak remove me # 卸载 starpak 自己
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## 工作原理
|
|
22
|
+
|
|
23
|
+
1. **智能检测** — 读取项目文件（package.json、Makefile、Cargo.toml、go.mod 等），自动识别运行时和构建系统
|
|
24
|
+
2. **自动安装** — 安装依赖、执行构建，无需手动配置
|
|
25
|
+
3. **零配置启动** — `cd` 进项目目录，`starpak start` 就能跑
|
|
26
|
+
4. **多项目支持** — 自动识别前后端分离项目，启动所有子服务
|
|
27
|
+
5. **启动脚本优先** — 检测到 `start.sh` / `run.sh` 时优先使用
|
|
28
|
+
|
|
29
|
+
## 安装
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm install -g starpak
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## 命令
|
|
36
|
+
|
|
37
|
+
| 命令 | 说明 |
|
|
38
|
+
|------|------|
|
|
39
|
+
| `install [target]` | 安装项目依赖 |
|
|
40
|
+
| `install -s <包名>` | 通过 apt 安装系统包 |
|
|
41
|
+
| `start` | 启动当前目录的项目 |
|
|
42
|
+
| `stop` | 停止当前目录的项目 |
|
|
43
|
+
| `restart` | 重启当前目录的项目 |
|
|
44
|
+
| `enable` | 配置 systemd 开机自启 |
|
|
45
|
+
| `disable` | 关闭 systemd 开机自启 |
|
|
46
|
+
| `status` | 查看运行状态 |
|
|
47
|
+
| `logs` | 查看运行日志 |
|
|
48
|
+
| `build [target]` | 构建项目 |
|
|
49
|
+
| `build -r` | 重新构建（先清理再构建） |
|
|
50
|
+
| `remove -s <包名>` | 卸载系统包 |
|
|
51
|
+
| `search <关键词>` | 搜索 GitHub 仓库 |
|
|
52
|
+
| `test install` | 模拟安装（显示分析结果，不真执行） |
|
|
53
|
+
|
|
54
|
+
## 设计哲学
|
|
55
|
+
|
|
56
|
+
- **cd 进去，剩下的自动完成** — 一个命令就够了
|
|
57
|
+
- **无数据库，无追踪** — 活在项目目录里，像 npm 一样
|
|
58
|
+
- **适配而非替代** — 站在 apt/npm/make/systemd 之上，不重复造轮子
|
|
59
|
+
- **彩蛋** — `starpak remove me` 卸载 starpak 自己
|
|
60
|
+
|
|
61
|
+
## 许可证
|
|
62
|
+
|
|
63
|
+
Apache-2.0
|
package/package.json
CHANGED
|
@@ -1,15 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "starpak",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
|
-
"description": "
|
|
6
|
+
"description": "Universal package manager, but not just packages! — cd in, the rest is automatic",
|
|
7
7
|
"bin": {
|
|
8
8
|
"starpak": "./cli/dist/index.cjs"
|
|
9
9
|
},
|
|
10
10
|
"files": [
|
|
11
11
|
"cli/dist/",
|
|
12
|
-
"README.md"
|
|
12
|
+
"README.md",
|
|
13
|
+
"README.zh.md"
|
|
13
14
|
],
|
|
14
15
|
"preferGlobal": true,
|
|
15
16
|
"engines": {
|