@v1nvn/md 0.23.0 → 0.25.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.
Files changed (2) hide show
  1. package/README.md +57 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,57 @@
1
+ # @v1nvn/md
2
+
3
+ The CLI behind the md plugin: it sends a Markdown reply — or any Markdown
4
+ file — to a self-hosted Markdown-Viewer as a `#share=` URL, opens the page,
5
+ and copies the link.
6
+
7
+ User-facing docs: [root README](../../README.md).
8
+
9
+ ## Quickstart
10
+
11
+ In Claude Code, the plugin is the way in — `/md:edit` (editable) and
12
+ `/md:view` (read-only) run this CLI through a `UserPromptExpansion` hook with
13
+ zero model tokens:
14
+
15
+ ```sh
16
+ claude plugin marketplace add v1nvn/agentic
17
+ claude plugin install md@agentic
18
+ ```
19
+
20
+ In a terminal, last reply or a named file:
21
+
22
+ ```sh
23
+ npx -y @v1nvn/md@0.25.0 # editable — both panes
24
+ npx -y @v1nvn/md@0.25.0 --view # read-only — preview pane only
25
+ npx -y @v1nvn/md@0.25.0 reply.md
26
+ ```
27
+
28
+ ## Usage
29
+
30
+ | Invocation | Does |
31
+ |---|---|
32
+ | `npx -y @v1nvn/md@0.25.0` | last reply → viewer, edit pane enabled, link copied |
33
+ | `npx -y @v1nvn/md@0.25.0 --view` | read-only share |
34
+ | `npx -y @v1nvn/md@0.25.0 reply.md` | that file instead of the last reply |
35
+
36
+ `MD_VIEWER_URL` sets the viewer (default `https://md.v1n.space`);
37
+ `MD_NO_OPEN=1` skips opening the browser.
38
+
39
+ ## Develop
40
+
41
+ ```sh
42
+ yarn workspace @v1nvn/md build
43
+ yarn workspace @v1nvn/md test
44
+ yarn lint && yarn typecheck # from the repo root
45
+ ```
46
+
47
+ ## Modules
48
+
49
+ | File | Role |
50
+ |---|---|
51
+ | `src/index.ts` | bin entry (`md-send`) — dispatch, exit codes |
52
+ | `src/share.ts` | the viewer upload and `#share=` URL |
53
+
54
+ ## Contracts
55
+
56
+ - One status line of output (e.g. `Opened in Markdown-Viewer (link copied).`).
57
+ - The document reaches only the configured viewer — no third-party service.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@v1nvn/md",
3
- "version": "0.23.0",
3
+ "version": "0.25.0",
4
4
  "description": "Send a Markdown reply to a self-hosted Markdown-Viewer as a #share= URL — the md-send CLI behind the md plugin.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -34,7 +34,7 @@
34
34
  "node": ">=22"
35
35
  },
36
36
  "dependencies": {
37
- "@v1nvn/agentic-core": "^0.23.0",
37
+ "@v1nvn/agentic-core": "^0.25.0",
38
38
  "commander": "^15.0.0"
39
39
  },
40
40
  "devDependencies": {