mcoda 0.1.4 → 0.1.8

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 (3) hide show
  1. package/CHANGELOG.md +1 -1
  2. package/README.md +28 -0
  3. package/package.json +13 -13
package/CHANGELOG.md CHANGED
@@ -3,5 +3,5 @@
3
3
  ## Unreleased
4
4
  - Initial npm packaging scaffold for the mcoda CLI.
5
5
 
6
- ## 0.1.4
6
+ ## 0.1.8
7
7
  - Initial public release of the mcoda CLI.
package/README.md CHANGED
@@ -13,6 +13,34 @@ mcoda set-workspace --workspace-root .
13
13
  mcoda docs pdr generate --workspace-root . --project WEB --rfp-path docs/rfp/web.md --agent codex
14
14
  ```
15
15
 
16
+ ## Workspace layout
17
+ - `.mcoda/config.json` for defaults (docdex URL, branch metadata, telemetry preferences).
18
+ - `.mcoda/mcoda.db` for backlog, jobs, and telemetry.
19
+ - `.mcoda/docs/` for generated artifacts.
20
+
21
+ ## Common commands
22
+ - Docs: `mcoda docs pdr generate`, `mcoda docs sds generate`
23
+ - Specs: `mcoda openapi-from-docs`
24
+ - Planning: `mcoda create-tasks`, `mcoda refine-tasks`, `mcoda order-tasks`
25
+ - Execution: `mcoda work-on-tasks`, `mcoda code-review`, `mcoda qa-tasks`
26
+ - Backlog: `mcoda backlog`, `mcoda task`
27
+ - Jobs/telemetry: `mcoda jobs`, `mcoda tokens`, `mcoda telemetry`
28
+ - Updates: `mcoda update --check`
29
+
30
+ ## Configuration
31
+ Environment variables are optional overrides for workspace settings:
32
+ - `MCODA_DOCDEX_URL` to point at a docdex server.
33
+ - `MCODA_API_BASE_URL` or `MCODA_JOBS_API_URL` for job APIs.
34
+ - `MCODA_TELEMETRY` set to `off` to disable telemetry.
35
+ - `MCODA_STREAM_IO=1` to emit agent I/O lines to stderr.
36
+
37
+ ## Programmatic usage
38
+ ```ts
39
+ import { McodaEntrypoint } from "mcoda";
40
+
41
+ await McodaEntrypoint.run(["--version"]);
42
+ ```
43
+
16
44
  ## Documentation
17
45
  Full docs live in the repository:
18
46
  - README: https://github.com/bekirdag/mcoda
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mcoda",
3
- "version": "0.1.4",
3
+ "version": "0.1.8",
4
4
  "description": "Local-first CLI for planning, documentation, and execution workflows with agent assistance.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -16,12 +16,6 @@
16
16
  "CHANGELOG.md",
17
17
  "LICENSE"
18
18
  ],
19
- "scripts": {
20
- "build": "tsc -p tsconfig.json",
21
- "lint": "echo \"lint not configured\"",
22
- "test": "pnpm run build && node ../../scripts/run-node-tests.js dist",
23
- "pack:verify": "node --test test/packaging_guardrails.test.js"
24
- },
25
19
  "engines": {
26
20
  "node": ">=20"
27
21
  },
@@ -50,12 +44,18 @@
50
44
  "access": "public"
51
45
  },
52
46
  "dependencies": {
53
- "@mcoda/core": "workspace:*",
54
- "@mcoda/shared": "workspace:*",
55
- "yaml": "^2.4.2"
47
+ "yaml": "^2.4.2",
48
+ "@mcoda/core": "0.1.8",
49
+ "@mcoda/shared": "0.1.8"
56
50
  },
57
51
  "devDependencies": {
58
- "@mcoda/db": "workspace:*",
59
- "@mcoda/integrations": "workspace:*"
52
+ "@mcoda/db": "0.1.8",
53
+ "@mcoda/integrations": "0.1.8"
54
+ },
55
+ "scripts": {
56
+ "build": "tsc -p tsconfig.json",
57
+ "lint": "echo \"lint not configured\"",
58
+ "test": "pnpm run build && node ../../scripts/run-node-tests.js dist",
59
+ "pack:verify": "node --test test/packaging_guardrails.test.js"
60
60
  }
61
- }
61
+ }