@mmmnt/flmnt 1.9.1 → 1.10.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/README.md +80 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# @mmmnt/flmnt
|
|
2
|
+
|
|
3
|
+
The developer CLI for the [flmnt](https://flmnt.ai) event-stream memory platform — authentication, workspace management, and the MCP auth helper that wires clients like Claude Code to a live, authenticated flmnt MCP.
|
|
4
|
+
|
|
5
|
+
This package is a thin installer: on `postinstall` it downloads the platform-native `flmnt` binary for your OS/architecture from the matching [GitHub release](https://github.com/mmmnt/flmnt-cli/releases), verifies it against the release checksums, and exposes it as the `flmnt` command. No Go toolchain required.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install -g @mmmnt/flmnt
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Requires Node.js ≥ 18. Supported platforms: macOS, Linux, and Windows on x64 and arm64.
|
|
14
|
+
|
|
15
|
+
Prefer a native package manager? The same CLI ships through several channels:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
brew install mmmnt/tap/flmnt # Homebrew (macOS/Linux)
|
|
19
|
+
scoop install flmnt # Scoop (Windows)
|
|
20
|
+
go install github.com/mmmnt/flmnt-cli@latest # Go
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Quickstart
|
|
24
|
+
|
|
25
|
+
Authenticate, pick a workspace, and wire Claude Code to your flmnt MCP:
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
flmnt login # OAuth2 — browser PKCE (or --device for headless)
|
|
29
|
+
flmnt workspace use <name|id> # set the active workspace
|
|
30
|
+
flmnt setup --server-url <flmnt-url> # write .mcp.json + the automation kit
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
`flmnt setup` writes a project-local `.mcp.json` pointing at the local proxy plus a `.claude/` hook map and slash commands; `flmnt proxy` then injects your bearer token on outbound MCP requests — so Claude Code talks to a live, authenticated flmnt MCP without you handling tokens by hand. `setup` is idempotent.
|
|
34
|
+
|
|
35
|
+
## Commands
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
flmnt help # list all commands
|
|
39
|
+
flmnt <command> -h # detailed help for a command
|
|
40
|
+
|
|
41
|
+
# Authentication
|
|
42
|
+
flmnt login # authenticate via OAuth2 (browser PKCE, or --device for headless)
|
|
43
|
+
flmnt logout # sign out and revoke local credentials
|
|
44
|
+
flmnt whoami # show the active identity and workspace
|
|
45
|
+
|
|
46
|
+
# Workspaces
|
|
47
|
+
flmnt workspace list # list workspaces you own or are a member of
|
|
48
|
+
flmnt workspace create <name> # create a workspace and make it active
|
|
49
|
+
flmnt workspace use <name|id> # set the active workspace
|
|
50
|
+
flmnt workspace members # list members of a workspace
|
|
51
|
+
flmnt workspace add-member # add a member to a workspace you own
|
|
52
|
+
flmnt workspace remove-member # remove a member from a workspace you own
|
|
53
|
+
|
|
54
|
+
# MCP / Claude Code integration
|
|
55
|
+
flmnt setup --server-url <url> # install the automation kit: .mcp.json + lifecycle hooks
|
|
56
|
+
# + .claude/commands/flmnt-* slash commands (idempotent)
|
|
57
|
+
flmnt proxy # run the local MCP proxy (injects Authorization: Bearer)
|
|
58
|
+
flmnt mcp auth-header # print MCP auth headers as JSON for .mcp.json
|
|
59
|
+
|
|
60
|
+
# Data
|
|
61
|
+
flmnt sync push # sync local Quorum data up to the remote workspace
|
|
62
|
+
flmnt sync pull # sync remote workspace data down to local
|
|
63
|
+
|
|
64
|
+
# Memory (continuity loop + deterministic writes for hooks / CI)
|
|
65
|
+
flmnt brief # SessionStart: inject latest keyframe + recent decisions + mistakes
|
|
66
|
+
flmnt derive --hook # Stop: derive decisions/keyframes/mistakes from transcript + git
|
|
67
|
+
flmnt record-metric --name <n> --value <v> # write an operational metric
|
|
68
|
+
flmnt record-plan --content <p> # write a multi-step plan
|
|
69
|
+
flmnt record-supersession --content <c> --supersedes <id> # replace a decision
|
|
70
|
+
|
|
71
|
+
# Utilities
|
|
72
|
+
flmnt health # check health of Core, Engine, and proxy services
|
|
73
|
+
flmnt gate # keyframe-recency check for the UserPromptSubmit hook
|
|
74
|
+
flmnt dashboard # open the dashboard in a browser
|
|
75
|
+
flmnt version # print the version
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## License
|
|
79
|
+
|
|
80
|
+
[Apache-2.0](./LICENSE). The flmnt CLI is open source; the flmnt platform is proprietary.
|