@hyperpuncher/pi-ui 0.38.2 → 0.39.1

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  # pi-ui
2
2
 
3
- keyboard-first minimal gui for [`pi`](https://pi.dev).
3
+ keyboard-first minimal gui for [`pi`](https://pi.dev)
4
4
 
5
5
  <div>
6
6
  <picture>
@@ -16,63 +16,98 @@ keyboard-first minimal gui for [`pi`](https://pi.dev).
16
16
  </picture>
17
17
  </div>
18
18
 
19
- features:
19
+ ## features
20
20
 
21
21
  - background sessions
22
22
  - git review with commit history and inline comments
23
23
  - markdown, syntax highlighting, and rich diffs
24
24
  - file attachments with image previews
25
25
 
26
- built with:
26
+ ## built with
27
27
 
28
28
  - [`datastar`](https://data-star.dev/)
29
29
  - [`kita-jsx`](https://github.com/kitajs/html)
30
30
  - [`pierre-diffs`](https://diffs.com/)
31
31
  - [`basecoat`](https://basecoatui.com/)
32
32
 
33
+ ## try
34
+
35
+ > requires bun 1.4+
36
+
37
+ ```sh
38
+ bunx @hyperpuncher/pi-ui
39
+ ```
40
+
33
41
  ## install
34
42
 
35
- after installing, open [http://127.0.0.1:31415](http://127.0.0.1:31415) in your browser.
43
+ ### quick install
36
44
 
37
- ### run without installing
45
+ > the quick installers start pi-ui in the background and at login
38
46
 
39
- requires bun 1.4 or newer
47
+ #### linux and macos
40
48
 
41
49
  ```sh
42
- bunx @hyperpuncher/pi-ui
50
+ curl -fsSL https://pi-ui.app/install | sh
43
51
  ```
44
52
 
45
- ### quick install (linux / mac)
53
+ #### windows
54
+
55
+ ```powershell
56
+ irm https://pi-ui.app/install.ps1 | iex
57
+ ```
58
+
59
+ open [http://127.0.0.1:31415](http://127.0.0.1:31415) in your browser
60
+
61
+ ### package managers
62
+
63
+ #### bun
64
+
65
+ > requires bun 1.4+
46
66
 
47
67
  ```sh
48
- curl -fsSL https://pi-ui.app/install | sh
68
+ bun i -g @hyperpuncher/pi-ui
49
69
  ```
50
70
 
51
- ### arch
71
+ #### arch
52
72
 
53
73
  ```sh
54
74
  paru -S pi-ui-bin
55
- pi-ui autostart enable
56
75
  ```
57
76
 
58
- ### mac
77
+ #### homebrew
59
78
 
60
79
  ```sh
61
80
  brew install hyperpuncher/tap/pi-ui
62
- brew services start pi-ui
63
81
  ```
64
82
 
65
- ### windows
83
+ > package-manager installs must be started with `pi-ui` or configured as a background service below
66
84
 
67
- ```powershell
68
- irm https://pi-ui.app/install.ps1 | iex
85
+ ## background service
86
+
87
+ start pi-ui now and at login:
88
+
89
+ ```sh
90
+ pi-ui service install
91
+ ```
92
+
93
+ stop pi-ui and remove the service:
94
+
95
+ ```sh
96
+ pi-ui service uninstall
69
97
  ```
70
98
 
71
- the windows installer starts pi-ui at login.
99
+ ### homebrew
100
+
101
+ homebrew manages the service separately:
102
+
103
+ ```sh
104
+ brew services start pi-ui
105
+ brew services stop pi-ui
106
+ ```
72
107
 
73
108
  ## development
74
109
 
75
- requires bun 1.4 or newer
110
+ > requires bun 1.4+
76
111
 
77
112
  ```sh
78
113
  bun ci