ithos 0.1.1 → 0.1.3
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 +37 -0
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +11 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# ithos
|
|
2
|
+
|
|
3
|
+
> The terminal CLI for Ithos — the local-first institutional memory layer for
|
|
4
|
+
> AI-assisted software development.
|
|
5
|
+
|
|
6
|
+
This is the command-line client used to initialize and manage an Ithos
|
|
7
|
+
repository.
|
|
8
|
+
|
|
9
|
+
For the full documentation, architecture details, and MCP setup guides, please
|
|
10
|
+
visit the [Main Ithos Repository](https://github.com/kry5h/ithos).
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
Install globally via npm:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install -g ithos
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Quick Start
|
|
21
|
+
|
|
22
|
+
Initialize Ithos in your current software repository:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
ithos init
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
This creates the `.ithos/` folder structure, setting up the repository context.
|
|
29
|
+
|
|
30
|
+
## Available Commands
|
|
31
|
+
|
|
32
|
+
- `ithos init`: Initialize a new Ithos directory structure.
|
|
33
|
+
- `ithos validate`: Verify your `.ithos/` directory matches the specification.
|
|
34
|
+
- `ithos doctor`: Inspect your local setup and diagnose issues.
|
|
35
|
+
- `ithos record`: Manually record an engineering decision, lesson, or session.
|
|
36
|
+
- `ithos search <query>`: Search matching lines across your engineering memory.
|
|
37
|
+
- `ithos export`: Concatenate and export the entire memory directory to stdout.
|
package/dist/cli.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAYpC,wBAAgB,SAAS,IAAI,OAAO,
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAYpC,wBAAgB,SAAS,IAAI,OAAO,CA0HnC"}
|
package/dist/cli.js
CHANGED
|
@@ -42,6 +42,8 @@ export function createCli() {
|
|
|
42
42
|
.requiredOption("-t, --type <type>", "artifact type")
|
|
43
43
|
.requiredOption("--title <title>", "artifact title")
|
|
44
44
|
.option("-b, --body <body>", "artifact body")
|
|
45
|
+
.option("--tags <tags>", "comma-separated tags")
|
|
46
|
+
.option("--related <related>", "comma-separated related artifact IDs or file paths")
|
|
45
47
|
.action(async (options) => {
|
|
46
48
|
if (!isArtifactType(options.type)) {
|
|
47
49
|
console.error(`Unsupported artifact type: ${options.type}`);
|
|
@@ -54,10 +56,18 @@ export function createCli() {
|
|
|
54
56
|
process.exitCode = 1;
|
|
55
57
|
return;
|
|
56
58
|
}
|
|
59
|
+
const tags = options.tags
|
|
60
|
+
? options.tags.split(",").map((t) => t.trim())
|
|
61
|
+
: undefined;
|
|
62
|
+
const related = options.related
|
|
63
|
+
? options.related.split(",").map((r) => r.trim())
|
|
64
|
+
: undefined;
|
|
57
65
|
const file = await recordArtifact({
|
|
58
66
|
type: options.type,
|
|
59
67
|
title: options.title,
|
|
60
|
-
body
|
|
68
|
+
body,
|
|
69
|
+
tags,
|
|
70
|
+
related
|
|
61
71
|
});
|
|
62
72
|
console.log(`Recorded ${file}`);
|
|
63
73
|
});
|