bizi 0.0.2 → 0.2.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.
Files changed (3) hide show
  1. package/README.md +57 -35
  2. package/bin/bizi.js +0 -0
  3. package/package.json +11 -7
package/README.md CHANGED
@@ -1,56 +1,78 @@
1
- # bizi TUI
1
+ https://github.com/user-attachments/assets/5478763d-57c5-4201-8ee7-a4e6239a8bcf
2
2
 
3
- Install dependencies:
3
+ # bizi
4
4
 
5
- ```bash
6
- bun install
7
- ```
5
+ bizi is a better way to manage dependent concurrent tasks.
6
+
7
+ > [!WARNING]
8
+ > This is still in early development breaking changes are likely.
9
+
10
+ ## Why?
11
+
12
+ If you have ever worked in a monorepo with multiple different tasks that depend on each other (for instance running your API in dev and running your web app in dev). Initially you might reach for something like concurrently to run this tasks in parallel. This works great until the moment where you need to restart one of the tasks, at which point you have no choice but to restart both tasks.
13
+
14
+ This is where bizi comes in. bizi allows you to define concurrent dependent tasks so and run them separately so that you can cancel, and restart them without effecting the other tasks.
15
+
16
+ The benefits go beyond just that though... Have you ever had that problem working with llms where they want to run their own dev server? bizi solves this by allowing llms to hook into the logs of your existing dev server run instead of spinning up their own.
17
+
18
+ ## Getting Started
8
19
 
9
- Run the server and then start the TUI:
20
+ ### Install the server
21
+
22
+ This will install the server and start it as a background service.
10
23
 
11
24
  ```bash
12
- cargo run -p bizi
13
- bun --cwd apps/tui dev -- --cwd /path/to/project
25
+ curl -fsSL https://getbizi.dev/install | bash
14
26
  ```
15
27
 
16
- If `--cwd` is omitted, the app uses the current shell working directory.
17
-
18
- ## Hotkeys
28
+ ### Install a client
19
29
 
20
- - `up/down` or `j/k`: move selection
21
- - `r`: run selected task
22
- - `R`: restart selected run
23
- - `c`: cancel selected run (and descendants)
24
- - `l`: toggle log mode (`aggregate` vs `selected`)
25
- - `q` or `Ctrl+C`: quit
30
+ Currently the only client is the TUI.
26
31
 
27
- ## Release packaging
32
+ ```bash
33
+ pnpm install -g bizi
34
+ ```
28
35
 
29
- - `bun compile` is release-only and is run from CI in `.github/workflows/release.yml`.
30
- - Local install/dev scripts do not compile binaries, and no lifecycle hooks trigger compile.
31
- - Publish order in CI:
32
- 1. compile binaries,
33
- 2. publish platform packages (`@getbizi/bizi-*`),
34
- 3. publish main CLI package (`bizi`).
36
+ ### Setup your task.config.json
37
+
38
+ ```jsonc
39
+ {
40
+ "$schema": "https://getbizi.dev/schemas/task.config.json",
41
+ "tasks": {
42
+ "dev": {
43
+ "tasks": {
44
+ "api": {
45
+ "cwd": "./apps/api",
46
+ "command": "dotnet run"
47
+ },
48
+ "site": {
49
+ "cwd": "./apps/site",
50
+ "command": "pnpm dev"
51
+ },
52
+ }
53
+ },
54
+ }
55
+ }
56
+ ```
35
57
 
36
- ## Local validation checks
58
+ ### Use the client
37
59
 
38
- Run from `apps/tui`:
60
+ Start the TUI from your project directory (where your `task.config.json` is):
39
61
 
40
62
  ```bash
41
- bun run compile:all
63
+ bizi
42
64
  ```
43
65
 
44
- Then verify binaries and launcher flow:
66
+ Or specify a working directory:
45
67
 
46
68
  ```bash
47
- ls -la ../../packages/bizi-darwin-arm64/bin
48
- ls -la ../../packages/bizi-darwin-x64/bin
49
- ls -la ../../packages/bizi-win32-x64/bin
50
- ls -la ../../packages/bizi-win32-arm64/bin
51
- node ./bin/bizi.js --help
69
+ bizi -cwd /path/to/project
52
70
  ```
53
71
 
54
- Notes:
72
+ You can also use CLI commands instead of the TUI (Perfect for your agents):
55
73
 
56
- - Windows arm64 currently uses a Windows x64 Bun executable fallback because Bun does not yet emit native Windows arm64 executables.
74
+ ```bash
75
+ bizi run <task> # Run a task
76
+ bizi cancel <task> # Cancel a running task
77
+ bizi stat <task> # Show task status
78
+ ```
package/bin/bizi.js CHANGED
File without changes
package/package.json CHANGED
@@ -1,8 +1,10 @@
1
1
  {
2
2
  "name": "bizi",
3
- "version": "0.0.2",
3
+ "version": "0.2.0",
4
4
  "description": "Terminal UI for bizi",
5
5
  "license": "MIT",
6
+ "repository": "https://github.com/ieedan/bizi",
7
+ "homepage": "https://getbizi.dev",
6
8
  "module": "src/index.tsx",
7
9
  "type": "module",
8
10
  "bin": {
@@ -19,13 +21,14 @@
19
21
  "compile:darwin-x64": "bun run scripts/build.ts compile darwin-x64",
20
22
  "compile:win32-x64": "bun run scripts/build.ts compile windows-x64",
21
23
  "compile:win32-arm64": "bun run scripts/build.ts compile windows-arm64",
22
- "compile:all": "bun run scripts/build.ts compile-all"
24
+ "compile:all": "bun run scripts/build.ts compile-all",
25
+ "pack": "bun run compile:all && bun run build:bundle && bun run compile:all && bun pm pack"
23
26
  },
24
27
  "optionalDependencies": {
25
- "@getbizi/bizi-darwin-arm64": "0.0.1",
26
- "@getbizi/bizi-darwin-x64": "0.0.1",
27
- "@getbizi/bizi-win32-x64": "0.0.1",
28
- "@getbizi/bizi-win32-arm64": "0.0.1"
28
+ "@getbizi/bizi-darwin-arm64": "workspace:*",
29
+ "@getbizi/bizi-darwin-x64": "workspace:*",
30
+ "@getbizi/bizi-win32-x64": "workspace:*",
31
+ "@getbizi/bizi-win32-arm64": "workspace:*"
29
32
  },
30
33
  "devDependencies": {
31
34
  "@types/bun": "latest"
@@ -39,7 +42,7 @@
39
42
  "@clack/prompts": "^1.0.1",
40
43
  "@opentui/core": "^0.1.79",
41
44
  "@opentui/solid": "^0.1.79",
42
- "@getbizi/client": "0.0.0",
45
+ "@getbizi/client": "workspace:*",
43
46
  "babel-preset-solid": "1.9.9",
44
47
  "commander": "^14.0.3",
45
48
  "picocolors": "^1.1.1",
@@ -47,3 +50,4 @@
47
50
  "zod": "^4.3.6"
48
51
  }
49
52
  }
53
+