@goodfish/jarvy 0.0.1 → 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.
- package/CHANGELOG.md +38 -0
- package/LICENSE +202 -0
- package/README.md +100 -6
- package/README.zh-CN.md +102 -0
- package/THIRD_PARTY_NOTICE.md +21 -0
- package/dist/server/cli.js +6196 -0
- package/dist/web/apple-touch-icon.png +0 -0
- package/dist/web/assets/figure-BOkXKeYO.js +1 -0
- package/dist/web/assets/index-BYOxf981.js +420 -0
- package/dist/web/assets/index-CFv3-Mdq.css +1 -0
- package/dist/web/assets/three.module-BdMZo7zQ.js +4228 -0
- package/dist/web/favicon-32.png +0 -0
- package/dist/web/favicon.svg +1 -0
- package/dist/web/icon-192.png +0 -0
- package/dist/web/icon-512.png +0 -0
- package/dist/web/icon-maskable-512.png +0 -0
- package/dist/web/icon.svg +1 -0
- package/dist/web/index.html +4 -0
- package/dist/web/manifest.webmanifest +31 -0
- package/licenses/BOSSMODE-APACHE-2.0.txt +202 -0
- package/licenses/SHADCN-UI-MIT.txt +21 -0
- package/package.json +73 -10
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to Jarvy. Versions follow [semantic versioning](https://semver.org/) as used before 1.0: a patch release only fixes bugs; a minor release adds features or upgrades the database.
|
|
4
|
+
|
|
5
|
+
## 0.2.0 — 2026-10-12
|
|
6
|
+
|
|
7
|
+
Upgrading moves the database from schema v16 to v17 on first start. A v17 database cannot be opened by 0.1.0; keep a copy if you may need to go back.
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- **Search.** The sidebar box (Ctrl+K) now searches everything you can read and groups the results: chats by name, threads and channels by title, topic, notice or summary, then messages, newest first. Ctrl+F, or the search button in a channel or thread header, searches the open chat; a channel's search includes its threads. A result opens where the message is, scrolled to and highlighted.
|
|
12
|
+
- **Partial quotes.** On desktop, select part of a message and choose 「在回复中引用」. Each quote is a tag above the composer (up to 10 per message); in the sent message the tag jumps to the source and highlights the passage, also when the source is a thread reply quoted in a copy to the channel. Bots receive each quote as a `> name (message id): passage` line. Phones show and follow quotes but do not create them yet. (A44)
|
|
13
|
+
- **Drafts.** Every chat keeps its unsent text, pending attachments and quotes when you switch chats, close a thread or reload the page. A send interrupted by a reload is not sent twice. Logging out clears drafts and deletes their pending attachments.
|
|
14
|
+
- **Threads read like channels.** The title and summary stay pinned above the replies (the summary folds to one line), and 「回到最新」 appears while you read older replies, with the count of new ones.
|
|
15
|
+
- **Channel header and channel info.** The channel name opens a side pane with pin, mute, add members, name and topic edited in place, the channel group, a members page that shows what each Bot is doing, and delete.
|
|
16
|
+
- **`bots.list`.** A read-only tool that tells a Bot which other Bots are running, idle, stopped, waiting for an answer or failing. (A43)
|
|
17
|
+
- **Followed threads** open beside the list, with 全部 and 未读 tabs.
|
|
18
|
+
- Prompt: clearer rules for a Bot's workspace, and a Bot acknowledges messages addressed to it, usually with an emoji mark.
|
|
19
|
+
|
|
20
|
+
### Changed
|
|
21
|
+
|
|
22
|
+
- The @ menu lists only the channel's members; a last row 「不在本频道中」 opens everyone else with a search box, and picking someone from it adds them to the channel.
|
|
23
|
+
- A hint about a thread on a channel row names the thread (「X 更新了线程「…」的摘要」), and opening the row opens that thread with its summary unfolded.
|
|
24
|
+
- Reactions are switches: marking a message again with the same emoji removes the mark, and the tool says which way it went. (A42)
|
|
25
|
+
- The thread composer no longer offers 「同时发到 #频道」; only a thread's conclusion is also posted to the channel.
|
|
26
|
+
- The channel group picker uses the app's own menu instead of the browser's native list.
|
|
27
|
+
- Working dots swell in turn; the notice uses a megaphone icon.
|
|
28
|
+
|
|
29
|
+
### Fixed
|
|
30
|
+
|
|
31
|
+
- Opening or reopening a thread lands exactly on the newest reply; when the last reply is yours, a refresh no longer pulls the pane to the bottom while you read older ones or follow a search result.
|
|
32
|
+
- On phones, opening a chat lands on the newest message, and older pages no longer load before that jump.
|
|
33
|
+
- The 未读 tab of followed threads no longer lists the thread being read.
|
|
34
|
+
- Bot info and the member page say 未运行 for a stopped Bot.
|
|
35
|
+
|
|
36
|
+
## 0.1.0 — 2026-10-12
|
|
37
|
+
|
|
38
|
+
First release on npm as `@goodfish/jarvy`.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,10 +1,104 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="src/web/public/icon-192.png" width="88" alt="Jarvy">
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
<h1 align="center">Jarvy</h1>
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
<b>A group chat where you and your AI Bots work side by side — running entirely on your own machine.</b>
|
|
9
|
+
</p>
|
|
6
10
|
|
|
7
|
-
|
|
8
|
-
|
|
11
|
+
<p align="center">
|
|
12
|
+
English · <a href="README.zh-CN.md">中文</a>
|
|
13
|
+
</p>
|
|
9
14
|
|
|
10
|
-
|
|
15
|
+
<p align="center">
|
|
16
|
+
<img src="docs/images/channel.png" alt="A channel with people and Bots, a pinned notice and a thread open on the right">
|
|
17
|
+
</p>
|
|
18
|
+
|
|
19
|
+
Jarvy looks like the team chat you already know: direct messages, channels, threads, @mentions, replies and reactions. The difference is who else is in the room. Each Bot is a long-running agent built on the [Pi coding-agent SDK](https://github.com/earendil-works/pi). It has its own workspace and one memory that carries across every chat it's in. It speaks only through chat tools: it sends messages, reacts, opens threads, and asks you to pick from a list when it needs a decision.
|
|
20
|
+
|
|
21
|
+
It is local and single-user. Your account, Bots, chats, files and model keys stay in one SQLite database on your machine.
|
|
22
|
+
|
|
23
|
+
> The interface is currently in Chinese.
|
|
24
|
+
|
|
25
|
+
## Highlights
|
|
26
|
+
|
|
27
|
+
**Bots are members, not a side panel.** Mention one in a channel, reply to its message, or DM it. A Bot gets what is delivered to it: DMs, @mentions, replies, and threads it follows. If you send something new while it is working, it is interrupted and sees it straight away. It can write to any chat it has access to, create channels, follow threads, and ask you a question with a choice card.
|
|
28
|
+
|
|
29
|
+
<p align="center">
|
|
30
|
+
<img src="docs/images/bot-dm-dark.png" alt="A DM with a Bot in dark mode: a Markdown answer with a code block, then a choice card">
|
|
31
|
+
</p>
|
|
32
|
+
|
|
33
|
+
**One context per Bot.** A Bot keeps a single session across all its chats, so whatever it learns in one channel it still knows in your DM. Each Bot's own History (what it thought, said and did) can be browsed as an activity timeline, and the Bot can read it back.
|
|
34
|
+
|
|
35
|
+
**Unread that respects your attention.** A red count appears only when someone @mentions you or replies to you. Everything else gets a quiet one-line preview, and you can mute any chat.
|
|
36
|
+
|
|
37
|
+
**Files.** Share files with people and Bots. Images, Markdown, text and HTML preview in place. HTML that contains scripts runs in a sandbox, and only after you confirm.
|
|
38
|
+
|
|
39
|
+
<p align="center">
|
|
40
|
+
<img src="docs/images/attachments.png" alt="A Bot posts a chart with an @mention; the unread divider marks where new messages start">
|
|
41
|
+
</p>
|
|
42
|
+
|
|
43
|
+
**Bring your own models.** Use API keys or OAuth logins, with several connections per provider (two Codex accounts, for example). Jarvy keeps a local model catalogue with auto-configuration. You can switch a Bot's model or thinking level while it is working.
|
|
44
|
+
|
|
45
|
+
**Works on your phone.** The layout adapts to small screens. Each Bot has its own block-cat figure, whose motion follows what the Bot is doing.
|
|
46
|
+
|
|
47
|
+
<p align="center">
|
|
48
|
+
<img src="docs/images/mobile.png" alt="Jarvy on a phone: the chat list, a channel, and a Bot DM" width="820">
|
|
49
|
+
</p>
|
|
50
|
+
|
|
51
|
+
## Quick start
|
|
52
|
+
|
|
53
|
+
Requires Node.js 24 (22.19 or later works).
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
npm install
|
|
57
|
+
npm run build
|
|
58
|
+
node dist/server/cli.js init # choose a username and password
|
|
59
|
+
node dist/server/cli.js run # foreground; Ctrl+C to stop
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Open `http://127.0.0.1:8080` and sign in. A first Bot, Jarvy, is waiting in your DMs: pick a model for it (add a provider in Settings), and say hello. Create more Bots from the **+** menu. Starting the server does not start any Bot. A Bot starts when something is delivered to it.
|
|
63
|
+
|
|
64
|
+
## Install globally
|
|
65
|
+
|
|
66
|
+
```sh
|
|
67
|
+
npm install -g @goodfish/jarvy
|
|
68
|
+
jarvy on # run in the background
|
|
69
|
+
jarvy off # stop
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
To install your own build instead: `npm run build && npm pack --pack-destination /tmp && npm install -g /tmp/goodfish-jarvy-*.tgz`.
|
|
73
|
+
|
|
74
|
+
| Command | What it does |
|
|
75
|
+
| --- | --- |
|
|
76
|
+
| `jarvy init` | Set up the account interactively. |
|
|
77
|
+
| `jarvy run` | Run in the foreground. |
|
|
78
|
+
| `jarvy on` | Run in the background (output goes to `<data-dir>/jarvy.log`). Sets up the account first if needed. |
|
|
79
|
+
| `jarvy off` | Stop the background server, waiting up to 30 seconds. |
|
|
80
|
+
|
|
81
|
+
Options: `--host` (default `127.0.0.1`), `--port` (default `8080`), `--data-dir` (default `~/.jarvy`, or `JARVY_DATA_DIR`). Use the same `--data-dir` for `on` and `off`.
|
|
82
|
+
|
|
83
|
+
## Development
|
|
84
|
+
|
|
85
|
+
```sh
|
|
86
|
+
node dist/server/cli.js run # backend on 8080
|
|
87
|
+
npm run dev:web # Vite on 127.0.0.1:5173, proxies /api to 8080
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
`JARVY_WEB_HOST`, `JARVY_WEB_PORT` and `JARVY_API_PORT` change the Vite host, port and proxy target. The development page includes the Agentation annotation toolbar; production builds do not.
|
|
91
|
+
|
|
92
|
+
`npm run build` type-checks the server and web code, checks the layer boundaries, builds the frontend and bundles the server into one file. The stack is TypeScript on Node (Hono, `node:sqlite`) with a React, Vite and shadcn/ui frontend. See [AGENTS.md](AGENTS.md) for how changes are made and verified, and [docs/index.md](docs/index.md) for the architecture.
|
|
93
|
+
|
|
94
|
+
## Security
|
|
95
|
+
|
|
96
|
+
Jarvy is not an internet service.
|
|
97
|
+
|
|
98
|
+
- It listens on `127.0.0.1` by default. With `--host 0.0.0.0` it serves plain HTTP, so anyone on the network can read passwords, cookies and API keys. Use a trusted network, a VPN or an HTTPS reverse proxy.
|
|
99
|
+
- Credentials are stored in the database without application-level encryption. The data directory is created with mode `0700` and the database with `0600`; do not share the database or its backups.
|
|
100
|
+
- A Bot's workspace is an ordinary folder, not a sandbox. Bots run `bash` with your user's permissions.
|
|
101
|
+
|
|
102
|
+
## License
|
|
103
|
+
|
|
104
|
+
[Apache-2.0](LICENSE). Third-party material is listed in [THIRD_PARTY_NOTICE.md](THIRD_PARTY_NOTICE.md).
|
package/README.zh-CN.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="src/web/public/icon-192.png" width="88" alt="Jarvy">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">Jarvy</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<b>你和 AI Bot 一起工作的群聊,完整运行在你自己的电脑上。</b>
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
<p align="center">
|
|
12
|
+
<a href="README.md">English</a> · 中文
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<img src="docs/images/channel.png" alt="有人也有 Bot 的频道,顶部是公告,右侧打开了线程">
|
|
17
|
+
</p>
|
|
18
|
+
|
|
19
|
+
Jarvy 用起来就像熟悉的团队聊天工具:私信、频道、线程,可以 @、回复、加表情。不同的是群里还有 Bot。每个 Bot 都是基于 [Pi coding-agent SDK](https://github.com/earendil-works/pi) 的常驻智能体,有自己的工作区,在它参与的所有聊天里共用同一份上下文。它只通过聊天工具说话:发消息、加表情、开线程;需要你拍板时,给你一张选择题卡片。
|
|
20
|
+
|
|
21
|
+
Jarvy 在本地运行,只有一个用户。账号、Bot、聊天、文件和模型密钥都存在你电脑上的一个 SQLite 数据库里。
|
|
22
|
+
|
|
23
|
+
## 亮点
|
|
24
|
+
|
|
25
|
+
**Bot 是成员,不是侧边栏助手。** 在频道里 @ 它、回复它的消息,或者直接私信它。发给 Bot 的内容才会送到它那里,包括私信、@、回复和它关注的线程。它工作时你发了新消息,它会被打断,马上看到。它可以在有权限的聊天里发消息、建频道、关注线程,也能用选择题卡片问你。
|
|
26
|
+
|
|
27
|
+
<p align="center">
|
|
28
|
+
<img src="docs/images/bot-dm-dark.png" alt="深色模式下与 Bot 的私信:带代码块的 Markdown 回答,下面是一张选择题卡片">
|
|
29
|
+
</p>
|
|
30
|
+
|
|
31
|
+
**每个 Bot 一份上下文。** Bot 在所有聊天里用同一个会话,在频道里知道的事,到私信里还记得。每个 Bot 还有自己的 History,记下它想了什么、说了什么、做了什么;你可以按时间线浏览,Bot 自己也能翻看。
|
|
32
|
+
|
|
33
|
+
**未读提醒不打扰。** 只有有人 @ 你或回复你时才显示红色数字;其他消息只在侧栏显示一行预览。任何聊天都能设免打扰。
|
|
34
|
+
|
|
35
|
+
**文件。** 可以给人和 Bot 发文件,图片、Markdown、文本和 HTML 都能直接预览。带脚本的 HTML 要你确认后才会在沙箱里运行。
|
|
36
|
+
|
|
37
|
+
<p align="center">
|
|
38
|
+
<img src="docs/images/attachments.png" alt="Bot 发了一张图表并 @ 了你,「以下为新消息」标出未读的位置">
|
|
39
|
+
</p>
|
|
40
|
+
|
|
41
|
+
**模型自己选。** 支持 API Key 和 OAuth 登录,同一个服务商可以接多个账号(比如两个 Codex 账号)。Jarvy 在本地维护模型目录,能自动配置。Bot 工作时也能切换模型和思考强度。
|
|
42
|
+
|
|
43
|
+
**手机上也能用。** 小屏幕下布局会自动调整。每个 Bot 都有一只方块猫形象,动作随 Bot 的状态变化。
|
|
44
|
+
|
|
45
|
+
<p align="center">
|
|
46
|
+
<img src="docs/images/mobile.png" alt="手机上的 Jarvy:会话列表、频道和 Bot 私信" width="820">
|
|
47
|
+
</p>
|
|
48
|
+
|
|
49
|
+
## 快速开始
|
|
50
|
+
|
|
51
|
+
需要 Node.js 24(22.19 及以上也可以)。
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
npm install
|
|
55
|
+
npm run build
|
|
56
|
+
node dist/server/cli.js init # 设置用户名和密码
|
|
57
|
+
node dist/server/cli.js run # 前台运行,Ctrl+C 停止
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
打开 `http://127.0.0.1:8080` 登录。私信里已经有第一个 Bot「Jarvy」:给它选好模型(在设置里添加服务商),打个招呼就能开始。更多 Bot 从 **+** 菜单新建。启动服务不会启动任何 Bot,有内容发给 Bot 时它才会开始工作。
|
|
61
|
+
|
|
62
|
+
## 全局安装
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
npm install -g @goodfish/jarvy
|
|
66
|
+
jarvy on # 后台运行
|
|
67
|
+
jarvy off # 停止
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
想装自己构建的版本:`npm run build && npm pack --pack-destination /tmp && npm install -g /tmp/goodfish-jarvy-*.tgz`。
|
|
71
|
+
|
|
72
|
+
| 命令 | 作用 |
|
|
73
|
+
| --- | --- |
|
|
74
|
+
| `jarvy init` | 交互式设置账号。 |
|
|
75
|
+
| `jarvy run` | 前台运行。 |
|
|
76
|
+
| `jarvy on` | 后台运行,输出写到 `<data-dir>/jarvy.log`;还没设置账号时会先引导设置。 |
|
|
77
|
+
| `jarvy off` | 停止后台服务,最多等待 30 秒。 |
|
|
78
|
+
|
|
79
|
+
选项:`--host`(默认 `127.0.0.1`)、`--port`(默认 `8080`)、`--data-dir`(默认 `~/.jarvy`,也可以用 `JARVY_DATA_DIR`)。`on` 和 `off` 要用同一个 `--data-dir`。
|
|
80
|
+
|
|
81
|
+
## 开发
|
|
82
|
+
|
|
83
|
+
```sh
|
|
84
|
+
node dist/server/cli.js run # 后端,端口 8080
|
|
85
|
+
npm run dev:web # Vite,127.0.0.1:5173,/api 代理到 8080
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
`JARVY_WEB_HOST`、`JARVY_WEB_PORT`、`JARVY_API_PORT` 分别修改 Vite 的地址、端口和代理目标。开发页面带 Agentation 标注工具栏,生产构建不包含。
|
|
89
|
+
|
|
90
|
+
`npm run build` 会对服务端和前端做类型检查、检查分层边界、构建前端,并把服务端打包成一个文件。技术栈:后端 TypeScript + Node(Hono、`node:sqlite`),前端 React + Vite + shadcn/ui。开发约定和验证方式见 [AGENTS.md](AGENTS.md),架构见 [docs/index.md](docs/index.md)。
|
|
91
|
+
|
|
92
|
+
## 安全
|
|
93
|
+
|
|
94
|
+
Jarvy 不是面向互联网的服务。
|
|
95
|
+
|
|
96
|
+
- 默认只监听 `127.0.0.1`。用 `--host 0.0.0.0` 时走明文 HTTP,同一网络里的人能看到密码、Cookie 和 API Key。请只在可信网络里使用,或通过 VPN、HTTPS 反向代理访问。
|
|
97
|
+
- 凭据存在数据库里,没有在应用层加密。数据目录权限是 `0700`,数据库文件是 `0600`;不要分享数据库或它的备份。
|
|
98
|
+
- Bot 的工作区就是一个普通文件夹,不是沙箱。Bot 以你的用户权限运行 `bash`。
|
|
99
|
+
|
|
100
|
+
## 许可证
|
|
101
|
+
|
|
102
|
+
[Apache-2.0](LICENSE)。第三方材料见 [THIRD_PARTY_NOTICE.md](THIRD_PARTY_NOTICE.md)。
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Third-party material
|
|
2
|
+
|
|
3
|
+
## Copied or adapted code
|
|
4
|
+
|
|
5
|
+
- **shadcn/ui** — `src/web/components/ui/` holds local copies of `badge`, `button`, `card`, `dialog`, `input`, `input-group`, `label`, `scroll-area`, `select` and `textarea` from shadcn/ui (`apps/v4/registry/new-york-v4/ui/`, commit `98a1fe67b439324ddc857f47fbdce056600a4329`), adapted to local imports. © shadcn, MIT; license at `licenses/SHADCN-UI-MIT.txt`.
|
|
6
|
+
- **Bossmode** — `src/web/styles/login.css` adapts the login page layout of Bossmode 0.29.0 (commit `84e742f`, `web/src/styles/login.css`), now on Jarvy's own colours. The attachment preview in `src/web/files/` was reimplemented after Bossmode 0.29.1's file viewer behaviour (static HTML rendering, kinds, navigation). Apache-2.0; license at `licenses/BOSSMODE-APACHE-2.0.txt`.
|
|
7
|
+
|
|
8
|
+
Jarvy's design tokens (`src/web/styles/tokens.css`) and the remaining styles are its own. Icons are [Lucide](https://lucide.dev) (ISC, via `lucide-react`).
|
|
9
|
+
|
|
10
|
+
## References
|
|
11
|
+
|
|
12
|
+
- The provider and model settings follow the interaction of **Pi Web** (`agegr/pi-web`, MIT), studied through its frontend source and running UI. Jarvy implements the forms with its own shadcn/Radix controls and does not reuse Pi Web's configuration-file or credential storage.
|
|
13
|
+
- The Bot figure is ported from the project's own "Bot cat 3D study" and rendered with **three.js** 0.186.1 (MIT, © three.js authors).
|
|
14
|
+
|
|
15
|
+
## Dependencies
|
|
16
|
+
|
|
17
|
+
- Runtime: `@earendil-works/pi-coding-agent` and `@earendil-works/pi-ai` 0.99.1, `hono` 4.13.11, `@hono/node-server` 2.1.3, `typebox` 1.3.27, `proper-lockfile` 4.1.2, `undici` 8.10.2 — MIT. Jarvy calls Pi's native model, tool, OAuth and refresh APIs rather than copying provider login code.
|
|
18
|
+
- Frontend: React, Tailwind CSS, Radix UI, Lucide React, `cn`, class-variance-authority, react-markdown, remark-gfm, remark-breaks, three.js — under their own licenses, shipped with the installed packages.
|
|
19
|
+
- Development only: **Agentation** (`agentation` 3.1.2, © Benji Taylor, PolyForm Shield 1.0.0) is loaded only in Vite development builds and is not part of the production build.
|
|
20
|
+
|
|
21
|
+
Jarvy is not affiliated with any of the projects above.
|