@openlatch/client 0.1.7 → 0.1.12
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/LICENSE +190 -0
- package/README.md +270 -0
- package/package.json +6 -6
package/LICENSE
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by the Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding any notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
Copyright 2024 OpenLatch AI
|
|
179
|
+
|
|
180
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
181
|
+
you may not use this file except in compliance with the License.
|
|
182
|
+
You may obtain a copy of the License at
|
|
183
|
+
|
|
184
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
185
|
+
|
|
186
|
+
Unless required by applicable law or agreed to in writing, software
|
|
187
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
188
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
189
|
+
See the License for the specific language governing permissions and
|
|
190
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/OpenLatch/openlatch-client/main/assets/banner.jpg" alt="OpenLatch — Security infrastructure for AI agents" width="600" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h3 align="center">See what your agent does. Block what it shouldn't.</h3>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<a href="https://github.com/OpenLatch/openlatch-client/actions/workflows/pr-checks.yml"><img src="https://github.com/OpenLatch/openlatch-client/actions/workflows/pr-checks.yml/badge.svg" alt="PR Checks" /></a>
|
|
9
|
+
<a href="https://codecov.io/gh/OpenLatch/openlatch-client"><img src="https://codecov.io/gh/OpenLatch/openlatch-client/graph/badge.svg" alt="codecov" /></a>
|
|
10
|
+
<a href="https://crates.io/crates/openlatch-client"><img src="https://img.shields.io/crates/v/openlatch-client.svg" alt="crates.io" /></a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/@openlatch/client"><img src="https://img.shields.io/npm/v/@openlatch/client.svg" alt="npm" /></a>
|
|
12
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" alt="License" /></a>
|
|
13
|
+
<a href="https://openlatch.slack.com"><img src="https://img.shields.io/badge/Slack-join%20us-4A154B?logo=slack&logoColor=white" alt="Slack" /></a>
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
**OpenLatch** is a thin, open-source security forwarder that plugs into AI agents via their **native lifecycle hooks**. One command installs protection across all your agents — no proxies, no code changes, no configuration.
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx @openlatch/client
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
That's it. OpenLatch auto-detects your installed agents, writes the hook configs, and starts forwarding events to the cloud for real-time security analysis.
|
|
25
|
+
|
|
26
|
+
<!-- TODO: Replace with VHS terminal recording once available -->
|
|
27
|
+
<!-- <p align="center">
|
|
28
|
+
<img src="https://raw.githubusercontent.com/OpenLatch/openlatch-client/main/assets/demo.gif" alt="OpenLatch demo" width="700" />
|
|
29
|
+
</p> -->
|
|
30
|
+
|
|
31
|
+
## Why OpenLatch?
|
|
32
|
+
|
|
33
|
+
AI agents execute shell commands, read files, call APIs, and install tools — all with your permissions. Most users have **zero visibility** into what their agents actually do.
|
|
34
|
+
|
|
35
|
+
OpenLatch gives you:
|
|
36
|
+
|
|
37
|
+
- **Visibility** — audit logs of every tool call, shell command, and file access across all your agents
|
|
38
|
+
- **Protection** — real-time detection of tool poisoning, credential leakage, prompt injection, and dangerous shell commands
|
|
39
|
+
- **Zero friction** — deploys from inside your agent in one command, auto-detects platforms, requires no security expertise
|
|
40
|
+
|
|
41
|
+
## Supported Platforms
|
|
42
|
+
|
|
43
|
+
OpenLatch works across **3 operating systems** and **8 agent platforms** from day one.
|
|
44
|
+
|
|
45
|
+
| Agent Platform | macOS | Windows | Linux | Hook Events |
|
|
46
|
+
| -------------- | :---: | :-----: | :---: | ----------: |
|
|
47
|
+
| Claude Code | :white_check_mark: | :white_check_mark: | :white_check_mark: | 24 |
|
|
48
|
+
| Cursor | :white_check_mark: | :white_check_mark: | :white_check_mark: | 5 |
|
|
49
|
+
| Windsurf | :white_check_mark: | :white_check_mark: | :white_check_mark: | 5 |
|
|
50
|
+
| GitHub Copilot | :white_check_mark: | :white_check_mark: | :white_check_mark: | 6 |
|
|
51
|
+
| Codex CLI | :white_check_mark: | :white_check_mark: | :white_check_mark: | 4 |
|
|
52
|
+
| Gemini CLI | :white_check_mark: | :white_check_mark: | :white_check_mark: | 4 |
|
|
53
|
+
| Cline | :white_check_mark: | :white_check_mark: | :white_check_mark: | 4 |
|
|
54
|
+
| OpenClaw | :white_check_mark: | :white_check_mark: | :white_check_mark: | 4 |
|
|
55
|
+
|
|
56
|
+
## Threat Coverage
|
|
57
|
+
|
|
58
|
+
| Threat Category | What it catches |
|
|
59
|
+
| --------------- | --------------- |
|
|
60
|
+
| **Tool Poisoning** | Malicious MCP servers, tampered tool definitions, supply chain attacks on agent tooling |
|
|
61
|
+
| **PII & Credential Leakage** | API keys, tokens, passwords, and personal data leaving your machine via agent actions |
|
|
62
|
+
| **Prompt Injection** | Injected instructions hidden in files, tool outputs, or web content that hijack agent behavior |
|
|
63
|
+
| **Shell Command Guardrails** | Destructive commands (`rm -rf /`), privilege escalation, crypto miners, reverse shells |
|
|
64
|
+
| **Supply Chain** | Compromised dependencies, typosquatted packages, unsigned binaries |
|
|
65
|
+
| **Attack Path Analysis** | Multi-step attack chains that combine individually benign actions into a malicious sequence |
|
|
66
|
+
|
|
67
|
+
## Quick Start
|
|
68
|
+
|
|
69
|
+
### Install via npm (recommended)
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
npx @openlatch/client
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Install via Cargo
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
cargo install openlatch-client
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Download binary
|
|
82
|
+
|
|
83
|
+
Pre-built binaries for macOS (ARM, Intel), Linux (x86_64, ARM), and Windows are available on the [Releases](https://github.com/OpenLatch/openlatch-client/releases) page.
|
|
84
|
+
|
|
85
|
+
## Usage
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
# Auto-detect agents, install hooks, and start the daemon
|
|
89
|
+
openlatch init
|
|
90
|
+
|
|
91
|
+
# Check daemon status, uptime, and event counts
|
|
92
|
+
openlatch status
|
|
93
|
+
|
|
94
|
+
# View the 20 most recent security events
|
|
95
|
+
openlatch logs
|
|
96
|
+
|
|
97
|
+
# Tail events in real time
|
|
98
|
+
openlatch logs -f
|
|
99
|
+
|
|
100
|
+
# Show events from the last hour
|
|
101
|
+
openlatch logs --since 1h
|
|
102
|
+
|
|
103
|
+
# Start/stop/restart the daemon
|
|
104
|
+
openlatch start
|
|
105
|
+
openlatch stop
|
|
106
|
+
openlatch restart
|
|
107
|
+
|
|
108
|
+
# Run daemon in foreground (useful for debugging)
|
|
109
|
+
openlatch start --foreground
|
|
110
|
+
|
|
111
|
+
# Diagnose configuration and connectivity issues
|
|
112
|
+
openlatch doctor
|
|
113
|
+
|
|
114
|
+
# Remove hooks and stop daemon
|
|
115
|
+
openlatch uninstall
|
|
116
|
+
|
|
117
|
+
# Remove hooks, stop daemon, and delete all data (~/.openlatch/)
|
|
118
|
+
openlatch uninstall --purge
|
|
119
|
+
|
|
120
|
+
# Open documentation in browser
|
|
121
|
+
openlatch docs
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Command Reference
|
|
125
|
+
|
|
126
|
+
| Command | Description |
|
|
127
|
+
| ------- | ----------- |
|
|
128
|
+
| `openlatch init` | Auto-detect agents, install hooks, start daemon. Safe to re-run. |
|
|
129
|
+
| `openlatch status` | Show daemon status, uptime, and event counts |
|
|
130
|
+
| `openlatch start [--foreground]` | Start the daemon (or run in foreground) |
|
|
131
|
+
| `openlatch stop` | Stop the daemon |
|
|
132
|
+
| `openlatch restart` | Restart the daemon |
|
|
133
|
+
| `openlatch logs [-f] [-n N] [--since T]` | View event logs. `-f` follows, `-n` limits count, `--since` filters by time |
|
|
134
|
+
| `openlatch doctor` | Diagnose configuration and connectivity issues |
|
|
135
|
+
| `openlatch doctor --fix` | Auto-heal common issues (config, hooks, daemon, binary). Creates `.bak` siblings and a journal so changes can be reverted with `--restore`. |
|
|
136
|
+
| `openlatch doctor --restore` | Reverse the most recent `--fix` run. Surgical merge for `~/.claude/settings.json` preserves user edits to non-OpenLatch hooks. |
|
|
137
|
+
| `openlatch doctor --rescue [--since 24h] [--output PATH] [--yes]` | Bundle a redacted diagnostic ZIP for sharing with support. Privacy filter runs on every text file; tokens are hard-redacted. |
|
|
138
|
+
| `openlatch uninstall [--purge] [--yes]` | Remove hooks and stop daemon. `--purge` deletes all data |
|
|
139
|
+
| `openlatch supervision {install,uninstall,enable,disable,status}` | Manage the OS-native supervisor that keeps the daemon alive after reboot (launchd / systemd --user / Task Scheduler). Installed by default during `openlatch init`; opt out with `openlatch init --no-persistence`. |
|
|
140
|
+
| `openlatch docs` | Open documentation in browser |
|
|
141
|
+
|
|
142
|
+
Noun-verb aliases are also available: `openlatch hooks install` = `init`, `openlatch hooks uninstall` = `uninstall`, `openlatch daemon start` = `start`, etc.
|
|
143
|
+
|
|
144
|
+
#### Persistence
|
|
145
|
+
|
|
146
|
+
`openlatch init` registers an OS-native supervisor by default so the daemon auto-starts when you log in or reboot — persistence is a security property, not a convenience. All three backends (macOS launchd, Linux systemd --user, Windows Task Scheduler) are user-scope only; no admin prompt, no sudo. Opt out with `openlatch init --no-persistence`, or toggle later with `openlatch supervision disable` / `enable`. `openlatch uninstall` always tears the supervisor down before stopping the daemon so it cannot auto-restart underneath you.
|
|
147
|
+
|
|
148
|
+
### Troubleshooting
|
|
149
|
+
|
|
150
|
+
When something goes wrong, prefer this order:
|
|
151
|
+
|
|
152
|
+
1. **Diagnose** — `openlatch doctor` lists every check that's failing (8 today: agent detection, config file, crash-report consent, auth token, daemon liveness, cloud reachability, hook installation, and recent fallback-log activity).
|
|
153
|
+
2. **Heal** — `openlatch doctor --fix` rewrites broken state files (config, token, hooks) and restarts the daemon. Every mutation is backed up to a `.bak` sibling and a journal at `~/.openlatch/fix-journal.json`. Exit code is 0 when post-fix checks all pass and 1 otherwise.
|
|
154
|
+
3. **Roll back** — `openlatch doctor --restore` reads the journal and reverses each reversible action. `~/.claude/settings.json` is restored via a surgical merge — non-OpenLatch hook entries you've added since `--fix` are preserved.
|
|
155
|
+
4. **Bundle for support** — `openlatch doctor --rescue --yes` produces `openlatch-rescue-<ts>-<machid>.zip` in `$PWD`. The bundle includes redacted state files, daemon `/health` + `/metrics` snapshots, binary metadata (SHA256 only — never bytes), and a per-pattern privacy-filter hit summary in `MANIFEST.json`. The bearer token in `daemon.token` is hard-redacted; absolute paths are anonymised to `~`.
|
|
156
|
+
|
|
157
|
+
Combined `openlatch doctor --fix --rescue` runs the rescue first to snapshot the pre-fix state, then heals.
|
|
158
|
+
|
|
159
|
+
### Global Flags
|
|
160
|
+
|
|
161
|
+
| Flag | Description |
|
|
162
|
+
| ---- | ----------- |
|
|
163
|
+
| `--json` | Machine-readable JSON output (parseable by `jq`) |
|
|
164
|
+
| `--verbose` / `-v` | Show extra operational detail |
|
|
165
|
+
| `--debug` | Show internal state and timings (implies `--verbose`) |
|
|
166
|
+
| `--quiet` / `-q` | Suppress all output except errors |
|
|
167
|
+
| `--no-color` | Disable colored output |
|
|
168
|
+
|
|
169
|
+
### Exit Codes
|
|
170
|
+
|
|
171
|
+
| Code | Meaning |
|
|
172
|
+
| ---- | ------- |
|
|
173
|
+
| 0 | Success |
|
|
174
|
+
| 1 | Security findings detected |
|
|
175
|
+
| 2 | Usage error (invalid arguments) |
|
|
176
|
+
| 3 | Resource not found |
|
|
177
|
+
| 4 | Permission denied |
|
|
178
|
+
| 5 | Conflict |
|
|
179
|
+
| 130 | Interrupted (Ctrl+C) |
|
|
180
|
+
|
|
181
|
+
### Binaries
|
|
182
|
+
|
|
183
|
+
OpenLatch ships two binaries:
|
|
184
|
+
|
|
185
|
+
- **`openlatch`** (<30MB) — full CLI for setup, daemon management, and log viewing.
|
|
186
|
+
- **`openlatch-hook`** (<20MB) — minimal hook handler spawned by agent hooks. Reads event JSON from stdin, forwards to the daemon on `localhost:7443`, and writes the verdict to stdout. If the daemon is unreachable, it fails open (returns allow) and logs to `~/.openlatch/logs/fallback.jsonl`. Not invoked directly by users.
|
|
187
|
+
|
|
188
|
+
## How It Works
|
|
189
|
+
|
|
190
|
+
OpenLatch uses a **three-layer architecture** — hooks live inside your agents, the client forwards events, and the cloud runs detection:
|
|
191
|
+
|
|
192
|
+
```
|
|
193
|
+
┌─────────────────────────────────────────────────────────────────┐
|
|
194
|
+
│ Your Machine │
|
|
195
|
+
│ │
|
|
196
|
+
│ ┌──────────┐ hook event ┌──────────────────────────────┐ │
|
|
197
|
+
│ │ Claude │─────────────▶│ │ │
|
|
198
|
+
│ │ Code │ │ OpenLatch Client │ │
|
|
199
|
+
│ ├──────────┤ │ (localhost:7443) │ │
|
|
200
|
+
│ │ Cursor │─────────────▶│ │ │
|
|
201
|
+
│ ├──────────┤ │ 1. Wrap in envelope │ │
|
|
202
|
+
│ │ Copilot │─────────────▶│ 2. Redact credentials │ │
|
|
203
|
+
│ ├──────────┤ │ 3. Forward to cloud │────┼──▶ OpenLatch Cloud
|
|
204
|
+
│ │ Gemini │─────────────▶│ 4. Return verdict │◀───┼── (allow / deny)
|
|
205
|
+
│ │ CLI │ │ 5. Write local audit log │ │
|
|
206
|
+
│ ├──────────┤ │ │ │
|
|
207
|
+
│ │ ... │─────────────▶│ │ │
|
|
208
|
+
│ └──────────┘ ◀─ verdict ─ └──────────────────────────────┘ │
|
|
209
|
+
│ │
|
|
210
|
+
└─────────────────────────────────────────────────────────────────┘
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
**Key design decisions:**
|
|
214
|
+
|
|
215
|
+
- **Hook-native** — OpenLatch plugs into each agent's official hook/extension system. It runs inside the agent runtime, not as a network proxy. Events cannot be bypassed.
|
|
216
|
+
- **Thin client, smart cloud** — the client wraps events in a standard envelope and forwards them. All detection, normalization, and analysis happens cloud-side.
|
|
217
|
+
- **Privacy-first** — credentials and secrets are redacted locally via regex-based filtering before anything leaves your machine.
|
|
218
|
+
- **Fail-open** — if the cloud is unreachable, agents continue working normally. Events are logged locally and synced later.
|
|
219
|
+
|
|
220
|
+
## Configuration
|
|
221
|
+
|
|
222
|
+
OpenLatch works with zero configuration. For advanced use cases:
|
|
223
|
+
|
|
224
|
+
```bash
|
|
225
|
+
# Configuration precedence (highest to lowest):
|
|
226
|
+
# 1. CLI flags
|
|
227
|
+
# 2. Environment variables (OPENLATCH_*)
|
|
228
|
+
# 3. Project config (.openlatch.json)
|
|
229
|
+
# 4. User config (~/.openlatch/config.toml)
|
|
230
|
+
# 5. Defaults
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
| Environment Variable | Description | Default |
|
|
234
|
+
| -------------------- | ----------- | ------- |
|
|
235
|
+
| `OPENLATCH_API_KEY` | Your OpenLatch API key | — |
|
|
236
|
+
| `OPENLATCH_API_URL` | Cloud API URL | `https://app.openlatch.ai/api` |
|
|
237
|
+
| `OPENLATCH_APP_URL` | Web app URL used for browser auth. Falls back to `OPENLATCH_API_URL` with a trailing `/api` stripped when unset. | `https://app.openlatch.ai` |
|
|
238
|
+
| `OPENLATCH_LOG_LEVEL` | Logging verbosity | `info` |
|
|
239
|
+
| `OPENLATCH_FAIL_MODE` | Behavior when cloud is unreachable | `open` |
|
|
240
|
+
|
|
241
|
+
## Security
|
|
242
|
+
|
|
243
|
+
OpenLatch is a security product — we hold ourselves to a high standard:
|
|
244
|
+
|
|
245
|
+
- **Responsible disclosure** — report vulnerabilities to **security@openlatch.ai**
|
|
246
|
+
- **Private vulnerability reporting** enabled on this repository
|
|
247
|
+
- All releases are built with **SLSA provenance** via GitHub Actions
|
|
248
|
+
- See [SECURITY.md](SECURITY.md) for our full security policy
|
|
249
|
+
|
|
250
|
+
## Contributing
|
|
251
|
+
|
|
252
|
+
We welcome contributions! Whether it's bug fixes, new agent integrations, or documentation improvements.
|
|
253
|
+
|
|
254
|
+
- Read our [Contributing Guide](.github/CONTRIBUTING.md) to get started
|
|
255
|
+
- Check [good first issues](https://github.com/OpenLatch/openlatch-client/labels/good%20first%20issue) for entry points
|
|
256
|
+
- Join our [Slack](https://openlatch.slack.com) to connect with the team
|
|
257
|
+
|
|
258
|
+
## License
|
|
259
|
+
|
|
260
|
+
Licensed under the [Apache License 2.0](LICENSE).
|
|
261
|
+
|
|
262
|
+
## Links
|
|
263
|
+
|
|
264
|
+
| Resource | URL |
|
|
265
|
+
| -------- | --- |
|
|
266
|
+
| Website | [openlatch.ai](https://openlatch.ai) |
|
|
267
|
+
| Documentation | [docs.openlatch.ai](https://docs.openlatch.ai) |
|
|
268
|
+
| Slack | [openlatch.slack.com](https://openlatch.slack.com) |
|
|
269
|
+
| Twitter / X | [@openlatch](https://x.com/openlatch) |
|
|
270
|
+
| GitHub | [github.com/OpenLatch](https://github.com/OpenLatch) |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openlatch/client",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.12",
|
|
4
4
|
"description": "OpenLatch — the open-source security layer for AI agents",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
@@ -19,10 +19,10 @@
|
|
|
19
19
|
"postinstall": "node lib/postinstall.js"
|
|
20
20
|
},
|
|
21
21
|
"optionalDependencies": {
|
|
22
|
-
"@openlatch/client-darwin-arm64": "0.1.
|
|
23
|
-
"@openlatch/client-darwin-x64": "0.1.
|
|
24
|
-
"@openlatch/client-linux-x64": "0.1.
|
|
25
|
-
"@openlatch/client-linux-arm64": "0.1.
|
|
26
|
-
"@openlatch/client-win32-x64": "0.1.
|
|
22
|
+
"@openlatch/client-darwin-arm64": "0.1.12",
|
|
23
|
+
"@openlatch/client-darwin-x64": "0.1.12",
|
|
24
|
+
"@openlatch/client-linux-x64": "0.1.12",
|
|
25
|
+
"@openlatch/client-linux-arm64": "0.1.12",
|
|
26
|
+
"@openlatch/client-win32-x64": "0.1.12"
|
|
27
27
|
}
|
|
28
28
|
}
|