@uns-kit/cli 0.0.64 → 0.0.65

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 (4) hide show
  1. package/package.json +1 -1
  2. package/templates/cron/AGENTS.md +23 -0
  3. package/templates/default/AGENTS.md +23 -0
  4. package/templates/default/README.md +4 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uns-kit/cli",
3
- "version": "0.0.64",
3
+ "version": "0.0.65",
4
4
  "description": "Command line scaffolding tool for UNS applications",
5
5
  "type": "module",
6
6
  "license": "MIT",
package/templates/cron/AGENTS.md ADDED
@@ -0,0 +1,23 @@
1
+ # Agent Onboarding (template)
2
+
3
+ Pointers for AI/code-assist tools when working in this generated project.
4
+
5
+ ## What to read locally
6
+
7
+ - `package.json` for scripts (`generate-uns-*`, `generate-codegen`, etc.).
8
+ - `config.schema.json` for the app config shape; `processName` is required.
9
+ - `src/examples/*.ts` for cron-driven publish patterns and description registration.
10
+ - Installed docs (under `node_modules`):
11
+ - `@uns-kit/core/README.md`
12
+ - `@uns-kit/api/README.md` (if installed)
13
+ - `@uns-kit/cron/README.md` (if installed)
14
+ - `@uns-kit/temporal/README.md` (if installed)
15
+ - `@uns-kit/cli/README.md` (if installed)
16
+
17
+ ## Generators in this project
18
+
19
+ - `pnpm run generate-uns-dictionary` -> updates `src/uns/uns-dictionary.generated.ts`
20
+ - `pnpm run generate-uns-measurements` -> updates `src/uns/uns-measurements.generated.ts`
21
+ - `pnpm run generate-uns-reference` -> runs both
22
+ - `pnpm run generate-uns-topics-tags` -> refreshes topic/tag unions (requires GraphQL connectivity)
23
+ - `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
package/templates/default/AGENTS.md ADDED
@@ -0,0 +1,23 @@
1
+ # Agent Onboarding (template)
2
+
3
+ Pointers for AI/code-assist tools when working in this generated project.
4
+
5
+ ## What to read locally
6
+
7
+ - `package.json` for scripts (`generate-uns-*`, `generate-codegen`, etc.).
8
+ - `config.schema.json` for the app config shape; `processName` is required.
9
+ - `src/examples/*.ts` for idiomatic publishing (multi-attribute) and description registration.
10
+ - Installed docs (under `node_modules`):
11
+ - `@uns-kit/core/README.md`
12
+ - `@uns-kit/api/README.md` (if installed)
13
+ - `@uns-kit/cron/README.md` (if installed)
14
+ - `@uns-kit/temporal/README.md` (if installed)
15
+ - `@uns-kit/cli/README.md` (if installed)
16
+
17
+ ## Generators in this project
18
+
19
+ - `pnpm run generate-uns-dictionary` -> updates `src/uns/uns-dictionary.generated.ts`
20
+ - `pnpm run generate-uns-measurements` -> updates `src/uns/uns-measurements.generated.ts`
21
+ - `pnpm run generate-uns-reference` -> runs both
22
+ - `pnpm run generate-uns-topics-tags` -> refreshes topic/tag unions (requires GraphQL connectivity)
23
+ - `pnpm run generate-codegen` -> GraphQL codegen (after configure-codegen)
package/templates/default/README.md CHANGED
@@ -35,3 +35,7 @@ Update `config.json` with your broker, UNS URLs, and credentials. The generated
35
35
  - Run `uns-kit configure-api` / `configure-cron` / `configure-temporal` to pull in example stubs and install the matching UNS plugins (add `--overwrite` to refresh templates).
36
36
  - Run `uns-kit configure-python` to copy the Python gateway client template (examples, scripts, proto).
37
37
  - Commit your new project and start building!
38
+
39
+ ## Agent Onboarding (for AI/code-assist tools)
40
+
41
+ For agent guidance, see the local [`AGENTS.md`](./AGENTS.md).