@okfit/cli 0.1.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 C. Spencer Beggs
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,13 @@
1
+ # @okfit/cli
2
+
3
+ The `okfit` command line for [Open Knowledge Format (OKF)](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) bundles.
4
+
5
+ > **Part of the okfit kit.** Most users want **[@okfit/plugin](https://www.npmjs.com/package/@okfit/plugin)**, which pulls this package in automatically.
6
+
7
+ ## Status
8
+
9
+ Skeleton. `okfit --version` and `okfit --help` work; no subcommands yet.
10
+
11
+ ## License
12
+
13
+ [MIT](LICENSE)
package/bin/okfit.js ADDED
@@ -0,0 +1,19 @@
1
+ #!/usr/bin/env node
2
+ import { rootCommand } from "../commands/root.js";
3
+ import { CLI_VERSION } from "../index.js";
4
+ import { Effect } from "effect";
5
+ import { Command } from "effect/unstable/cli";
6
+ import * as NodeRuntime from "@effect/platform-node/NodeRuntime";
7
+ import * as NodeServices from "@effect/platform-node/NodeServices";
8
+
9
+ //#region src/bin.ts
10
+ /**
11
+ * CLI entry point for okfit.
12
+ *
13
+ * @packageDocumentation
14
+ */
15
+ const cli = Command.run(rootCommand, { version: CLI_VERSION });
16
+ NodeRuntime.runMain(cli.pipe(Effect.provide(NodeServices.layer)));
17
+
18
+ //#endregion
19
+ export { };
@@ -0,0 +1,13 @@
1
+ import { Console } from "effect";
2
+ import { Command } from "effect/unstable/cli";
3
+
4
+ //#region src/commands/root.ts
5
+ /**
6
+ * The `okfit` root command. Subcommands are attached in later releases.
7
+ *
8
+ * @public
9
+ */
10
+ const rootCommand = Command.make("okfit", {}, () => Console.log("okfit: no subcommands are available yet. Run `okfit --help`."));
11
+
12
+ //#endregion
13
+ export { rootCommand };
package/index.d.ts ADDED
@@ -0,0 +1,19 @@
1
+ import { Command } from "effect/unstable/cli";
2
+ //#region src/commands/root.d.ts
3
+ /**
4
+ * The `okfit` root command. Subcommands are attached in later releases.
5
+ *
6
+ * @public
7
+ */
8
+ declare const rootCommand: Command.Command<"okfit", {}, {}, never, never>;
9
+ //#endregion
10
+ //#region src/index.d.ts
11
+ /**
12
+ * The version string reported by `okfit --version`.
13
+ *
14
+ * @public
15
+ */
16
+ declare const CLI_VERSION = "0.0.0";
17
+ //#endregion
18
+ export { CLI_VERSION, rootCommand };
19
+ //# sourceMappingURL=index.d.ts.map
package/index.js ADDED
@@ -0,0 +1,12 @@
1
+ import { rootCommand } from "./commands/root.js";
2
+
3
+ //#region src/index.ts
4
+ /**
5
+ * The version string reported by `okfit --version`.
6
+ *
7
+ * @public
8
+ */
9
+ const CLI_VERSION = "0.0.0";
10
+
11
+ //#endregion
12
+ export { CLI_VERSION, rootCommand };
package/package.json ADDED
@@ -0,0 +1,48 @@
1
+ {
2
+ "name": "@okfit/cli",
3
+ "version": "0.1.0",
4
+ "private": false,
5
+ "description": "The okfit command line: validate, lint, index, and inspect Open Knowledge Format (OKF) bundles.",
6
+ "keywords": [
7
+ "okf",
8
+ "open-knowledge-format",
9
+ "cli",
10
+ "effect"
11
+ ],
12
+ "homepage": "https://github.com/spencerbeggs/okfit/tree/main/packages/cli#readme",
13
+ "bugs": {
14
+ "url": "https://github.com/spencerbeggs/okfit/issues"
15
+ },
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "git+https://github.com/spencerbeggs/okfit.git",
19
+ "directory": "packages/cli"
20
+ },
21
+ "license": "MIT",
22
+ "author": {
23
+ "name": "C. Spencer Beggs",
24
+ "email": "spencer@beggs.codes",
25
+ "url": "https://spencerbeg.gs"
26
+ },
27
+ "type": "module",
28
+ "exports": {
29
+ ".": {
30
+ "types": "./index.d.ts",
31
+ "import": "./index.js",
32
+ "default": "./index.js"
33
+ },
34
+ "./package.json": "./package.json"
35
+ },
36
+ "bin": {
37
+ "okfit": "bin/okfit.js"
38
+ },
39
+ "dependencies": {
40
+ "@effect/platform-node": "4.0.0-rc.109",
41
+ "@okfit/core": "0.1.0",
42
+ "@okfit/profiles": "0.1.0",
43
+ "effect": "4.0.0-rc.109"
44
+ },
45
+ "engines": {
46
+ "node": ">=24.11.0"
47
+ }
48
+ }
@@ -0,0 +1,11 @@
1
+ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
+ // It should be published with your NPM package. It should not be tracked by Git.
3
+ {
4
+ "tsdocVersion": "0.12",
5
+ "toolPackages": [
6
+ {
7
+ "packageName": "@microsoft/api-extractor",
8
+ "packageVersion": "7.59.0"
9
+ }
10
+ ]
11
+ }