openflowkit 0.0.0-stage → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Varun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,18 @@
-# Temporary Holding Version
+# openflowkit
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The [OpenFlowKit](https://openflowkit.com) command line. Turn diagram text into SVG, check diagrams in CI, and map a repository.
+
+```sh
+npx openflowkit render flow.mmd -o flow.svg        # Mermaid, D2, Structurizr or OpenFlow DSL → SVG
+npx openflowkit convert flow.mmd -o flow.openflow.json   # → a file you can open and edit in the app
+npx openflowkit validate flow.ofk                  # line-by-line errors; exit 1 on a broken diagram
+npx openflowkit discover .                         # propose an architecture model from the repo
+npx openflowkit map . --html map.html              # what the repo is made of, as a page
+npx openflowkit --help                             # every command
+```
+
+Install it once with `npm i -g openflowkit`, then run `openflowkit …`.
+
+This package is a short name for [`@vrun-design/openflowkit-mcp`](https://www.npmjs.com/package/@vrun-design/openflowkit-mcp), which also ships the MCP server for Claude Code, Cursor and other agents. Docs: [docs.openflowkit.com/cli](https://docs.openflowkit.com/cli/).
+
+MIT licensed.

package/openflowkit-mcp.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// The MCP server, for clients configured with `npx -y openflowkit-mcp` via this package.
+import '@vrun-design/openflowkit-mcp/dist/index.js';

package/openflowkit.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// `npx openflowkit …`: the CLI lives in @vrun-design/openflowkit-mcp; this name only makes it short.
+import '@vrun-design/openflowkit-mcp/dist/cli.js';

package/package.json

@@ -1,6 +1,15 @@
 {
   "name": "openflowkit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.1",
+  "description": "The OpenFlowKit CLI: render Mermaid, D2, Structurizr or OpenFlow DSL to SVG, validate diagrams in CI, map a repo. Same as @vrun-design/openflowkit-mcp.",
+  "keywords": ["diagram", "cli", "mermaid", "d2", "structurizr", "svg", "architecture", "mcp", "openflowkit"],
+  "homepage": "https://docs.openflowkit.com/cli/",
+  "bugs": "https://github.com/Vrun-design/openflowkit/issues",
+  "repository": { "type": "git", "url": "https://github.com/Vrun-design/openflowkit.git", "directory": "cli" },
+  "license": "MIT",
+  "type": "module",
+  "bin": { "openflowkit": "./openflowkit.js", "openflowkit-mcp": "./openflowkit-mcp.js" },
+  "files": ["openflowkit.js", "openflowkit-mcp.js", "README.md", "LICENSE"],
+  "engines": { "node": ">=20.11" },
+  "dependencies": { "@vrun-design/openflowkit-mcp": ">=0.2.1 <1.0.0" }
+}