@brokkai/mjolnir-linux-arm64-gnu 1.5.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 ADDED
@@ -0,0 +1,168 @@
1
+ <h1 align="center">Mjolnir</h1>
2
+
3
+ <p align="center">
4
+ <a href="https://mjolnir.brokk.ai/">
5
+ <img src="docs/public/og.png" alt="Mjolnir — the self-hosted power frontend for Codex" width="720">
6
+ </a>
7
+ </p>
8
+
9
+ Mjolnir (`mj`) is the self-hosted power frontend for **Codex**. It wraps your
10
+ existing Codex account in self-hosted remote control, a worktree-first workflow,
11
+ cross-platform voice input, and integrated adversarial review.
12
+
13
+ Codex remains in charge of the turn while Mjolnir provides the operating
14
+ environment around it:
15
+
16
+ - Codex owns every user turn — planning, delegating, implementing, and
17
+ answering;
18
+ - Codex can launch background subagents (up to 16 in parallel, all
19
+ write-capable, each in a fresh session) while Mjolnir tracks them;
20
+ - stable workflow progress rows summarize delegation and review phases,
21
+ aggregate actor outcomes, and elapsed time; `/subagents` opens retained
22
+ nested detail;
23
+ - each finished subagent's report, activity log, and diff are pushed back into
24
+ the primary session as a new user message — nothing polls.
25
+
26
+ Mjolnir is Codex-first, not Codex-only. You can add Claude, Kimi, Anvil, or a
27
+ custom Agent Client Protocol (ACP) server as an alternative primary or as a
28
+ specialist subagent or reviewer. The terminal, permissions, sessions, tools,
29
+ and remote workflow stay consistent across those routes.
30
+
31
+ ![Mjolnir inline Codex session showing streaming agent output and tool activity](docs/readme-images/default-ui.png)
32
+
33
+ ## What Mjolnir adds to Codex
34
+
35
+ - **Self-hosted remote control:** keep the workspace and control plane on your
36
+ machine and drive the session from another browser or device.
37
+ - **Worktree-first workflow:** start Codex in a linked Git worktree so agent
38
+ changes stay separate from your current checkout and remain easy to inspect.
39
+ - **Cross-platform desktop voice:** dictate prompts locally on macOS, Linux,
40
+ and Windows with Ctrl-R.
41
+ - **Integrated adversarial review:** challenge workspace changes with a
42
+ separate review supervisor and targeted specialist lanes before a delegated
43
+ turn completes.
44
+ - **Optional agent routes:** add Claude, Kimi, Anvil, or a custom ACP server
45
+ without replacing the Codex-first workflow.
46
+
47
+ Mjolnir itself, its remote-control server, transcripts, and workspace tools run
48
+ on infrastructure you control. Codex model requests still use OpenAI under the
49
+ terms and data boundaries of your Codex account.
50
+
51
+ ## Requirements
52
+
53
+ The recommended path needs an authenticated, PATH-visible Codex CLI plus
54
+ Node.js/npm for the Codex ACP bridge. Provider use may incur cost.
55
+
56
+ Other agents are optional. Mjolnir can also use existing Claude or Kimi
57
+ credentials, install supported binary ACP agents, and manage Anvil as a bundled
58
+ or downloaded route. Read [Start with Codex](https://mjolnir.brokk.ai/codex/),
59
+ [installation](https://mjolnir.brokk.ai/install/), and the
60
+ [data and trust boundaries](https://mjolnir.brokk.ai/data-boundaries/)
61
+ before connecting a private repository.
62
+
63
+ ## Install and run
64
+
65
+ With Node.js 18 or later, npm is the simplest persistent install and npx runs
66
+ Mjolnir once without changing your global packages:
67
+
68
+ ```bash
69
+ npm install -g @brokkai/mjolnir
70
+ mj --version
71
+
72
+ npx -y @brokkai/mjolnir --version
73
+ npx -y @brokkai/mjolnir@1.5.1 --version
74
+ ```
75
+
76
+ The npm package includes the native `mj` bundle for your platform—plus bundled
77
+ Anvil and, on desktop, `mj-voice-worker`—so it does not download Mjolnir on
78
+ first run. Upgrade with `npm update -g @brokkai/mjolnir` and remove it with
79
+ `npm uninstall -g @brokkai/mjolnir`.
80
+
81
+ On macOS (Apple Silicon and Intel) and Linux (x86-64 or ARM64 glibc), install
82
+ from the Homebrew tap:
83
+
84
+ ```bash
85
+ brew install brokkai/tap/mjolnir
86
+ ```
87
+
88
+ The formula puts `mj` on `PATH` and keeps `mj-voice-worker` and a bundled
89
+ Anvil in its private `libexec`; it does not install Bifrost, which has its own
90
+ formula in the same tap (`brew install brokkai/tap/bifrost`). Upgrade with
91
+ `brew upgrade mjolnir`.
92
+
93
+ The release installer supports macOS and Linux on x86-64 or ARM64, plus Android ARM64:
94
+
95
+ ```bash
96
+ curl -fsSL https://raw.githubusercontent.com/BrokkAi/mjolnir/master/install.sh | bash
97
+ ```
98
+
99
+ It installs `mj` and Bifrost; desktop installs also include
100
+ `mj-voice-worker`. Windows users should use a release archive or Cargo.
101
+
102
+ Desktop users can install Mjolnir and its optional voice worker from crates.io:
103
+
104
+ ```bash
105
+ cargo install --locked brokk-mjolnir brokk-mj-voice-worker
106
+ ```
107
+
108
+ Then open a repository and run:
109
+
110
+ ```bash
111
+ mj
112
+ ```
113
+
114
+ First launch opens Mjolnir's configuration screen. Confirm the Codex account
115
+ and route, keep the primary model on Auto, and start the session. Return later
116
+ with `/mjconfig`. Model and adapter changes apply to the next session. If Codex
117
+ credentials or capabilities change under a running Mjolnir process, use
118
+ `/models refresh` before `/new` or `/clear`; the standalone equivalent is `mj
119
+ models refresh`.
120
+
121
+ ## Try it
122
+
123
+ The [10-minute Codex evaluation](https://mjolnir.brokk.ai/evaluate/) uses a
124
+ checked-in disposable fixture to exercise a delegated subagent change, its
125
+ pushed-back report, explicit review, session resume, and headless output without
126
+ risking a real repository.
127
+
128
+ For a quick read-only headless check:
129
+
130
+ ```bash
131
+ mj --print --permission-mode manual "summarize this repository; do not modify files"
132
+ ```
133
+
134
+ Use an isolated worktree for an interactive coding session:
135
+
136
+ ```bash
137
+ mj --worktree
138
+ ```
139
+
140
+ ## Documentation
141
+
142
+ - [Start with Codex](https://mjolnir.brokk.ai/codex/)
143
+ - [Install and run](https://mjolnir.brokk.ai/install/)
144
+ - [10-minute Codex evaluation](https://mjolnir.brokk.ai/evaluate/)
145
+ - [Remote control](https://mjolnir.brokk.ai/remote/)
146
+ - [Voice dictation](https://mjolnir.brokk.ai/voice/)
147
+ - [Subagents](https://mjolnir.brokk.ai/subagents/)
148
+ - [Delegation and adversarial review](https://mjolnir.brokk.ai/delegation-review/)
149
+ - [Permissions and workspace scope](https://mjolnir.brokk.ai/permissions/)
150
+ - [Sessions, worktrees, and resume](https://mjolnir.brokk.ai/sessions-worktrees/)
151
+ - [Headless automation](https://mjolnir.brokk.ai/headless/)
152
+ - [Other agents and models](https://mjolnir.brokk.ai/adapters/)
153
+ - [License and use cases](https://mjolnir.brokk.ai/license-use-cases/)
154
+ - [Data and trust boundaries](https://mjolnir.brokk.ai/data-boundaries/)
155
+
156
+ ## Contributing
157
+
158
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, runtime
159
+ invariants, tests, dependency-license maintenance, and the release checklist.
160
+ Repository-specific agent guidance lives in [AGENTS.md](AGENTS.md).
161
+
162
+ ## License
163
+
164
+ Mjolnir and its voice worker are licensed under `GPL-3.0-only`. See
165
+ [LICENSE](LICENSE). Official release archives include the corresponding source
166
+ offer, dependency reports, supplemental notices, and the legal bundle for the
167
+ shipped Anvil binary. See [License and use cases](https://mjolnir.brokk.ai/license-use-cases/)
168
+ and [Third-party notices](https://mjolnir.brokk.ai/third-party-notices/).