@howone/agent-cli 0.0.0-stage → 0.5.1
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 +34 -2
- package/bin/index.d.mts +1 -0
- package/bin/index.mjs +2450 -0
- package/package.json +55 -4
- package/skills/howone/01-apps.md +29 -0
- package/skills/howone/02-develop.md +107 -0
- package/skills/howone/03-workflows.md +71 -0
- package/skills/howone/04-functions-and-data.md +41 -0
- package/skills/howone/05-capabilities.md +46 -0
- package/skills/howone/SKILL.md +52 -0
- package/templates/vite/.howone/skills/hallmark/SKILL.md +557 -0
- package/templates/vite/.howone/skills/hallmark/references/anti-patterns.md +418 -0
- package/templates/vite/.howone/skills/hallmark/references/assets.md +406 -0
- package/templates/vite/.howone/skills/hallmark/references/color.md +95 -0
- package/templates/vite/.howone/skills/hallmark/references/component-cookbook.md +265 -0
- package/templates/vite/.howone/skills/hallmark/references/components/c1-outlined-chip.md +12 -0
- package/templates/vite/.howone/skills/hallmark/references/components/c2-inline-form-as-cta.md +16 -0
- package/templates/vite/.howone/skills/hallmark/references/components/c3-typographic-link.md +8 -0
- package/templates/vite/.howone/skills/hallmark/references/components/c4-sticky-bottom-bar.md +16 -0
- package/templates/vite/.howone/skills/hallmark/references/components/f1-bento-grid.md +20 -0
- package/templates/vite/.howone/skills/hallmark/references/components/f2-sticky-scroll-stack.md +20 -0
- package/templates/vite/.howone/skills/hallmark/references/components/f3-tabular-spec-sheet.md +11 -0
- package/templates/vite/.howone/skills/hallmark/references/components/f4-step-sequence.md +11 -0
- package/templates/vite/.howone/skills/hallmark/references/components/f5-annotated-screenshot.md +11 -0
- package/templates/vite/.howone/skills/hallmark/references/components/f6-product-card-grid.md +41 -0
- package/templates/vite/.howone/skills/hallmark/references/components/ft1-mast-headed.md +13 -0
- package/templates/vite/.howone/skills/hallmark/references/components/ft2-inline-rule-single-line.md +10 -0
- package/templates/vite/.howone/skills/hallmark/references/components/ft3-index-style-category-list.md +12 -0
- package/templates/vite/.howone/skills/hallmark/references/components/ft4-dense-typographic.md +10 -0
- package/templates/vite/.howone/skills/hallmark/references/components/ft5-statement.md +21 -0
- package/templates/vite/.howone/skills/hallmark/references/components/ft6-letter-close.md +19 -0
- package/templates/vite/.howone/skills/hallmark/references/components/ft7-newsletter-first.md +27 -0
- package/templates/vite/.howone/skills/hallmark/references/components/ft8-marquee-scroll.md +25 -0
- package/templates/vite/.howone/skills/hallmark/references/components/h1-marquee.md +15 -0
- package/templates/vite/.howone/skills/hallmark/references/components/h2-split-diptych.md +15 -0
- package/templates/vite/.howone/skills/hallmark/references/components/h3-quote-led.md +11 -0
- package/templates/vite/.howone/skills/hallmark/references/components/h4-stat-led.md +14 -0
- package/templates/vite/.howone/skills/hallmark/references/components/h5-letter-hero.md +11 -0
- package/templates/vite/.howone/skills/hallmark/references/components/h6-photographic-fold.md +16 -0
- package/templates/vite/.howone/skills/hallmark/references/components/h7-demo-video-clipped-by-viewport-edge.md +27 -0
- package/templates/vite/.howone/skills/hallmark/references/components/h8-mockup-split-browser-framed.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/components/h9-custom-illustration-centerpiece.md +27 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n1-wordmark-2-links.md +12 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n10-floating-on-scroll-morph.md +19 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n11-mega-menu.md +40 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n12-banner-retract.md +34 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n13-inline-cmdk-pill.md +39 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n1b-saas-three-section.md +35 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n2-floating-chip.md +14 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n3-side-rail.md +14 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n4-hidden-behind-k.md +9 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n5-floating-pill.md +28 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n6-newspaper-masthead.md +24 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n7-brutal-slab.md +22 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n8-terminal-command.md +21 -0
- package/templates/vite/.howone/skills/hallmark/references/components/n9-edge-aligned-minimal.md +17 -0
- package/templates/vite/.howone/skills/hallmark/references/components/s1-left-margin-numbered.md +15 -0
- package/templates/vite/.howone/skills/hallmark/references/components/s2-hanging.md +13 -0
- package/templates/vite/.howone/skills/hallmark/references/components/s3-sticky-pinned.md +19 -0
- package/templates/vite/.howone/skills/hallmark/references/components/s4-inline-no-break.md +11 -0
- package/templates/vite/.howone/skills/hallmark/references/components/s5-bottom-anchored.md +13 -0
- package/templates/vite/.howone/skills/hallmark/references/components/t1-pull-quote-with-marginalia.md +12 -0
- package/templates/vite/.howone/skills/hallmark/references/components/t2-logo-wall-hairline.md +19 -0
- package/templates/vite/.howone/skills/hallmark/references/components/t3-single-huge-quote.md +11 -0
- package/templates/vite/.howone/skills/hallmark/references/components/t4-numbered-stat-strip.md +14 -0
- package/templates/vite/.howone/skills/hallmark/references/contract.md +24 -0
- package/templates/vite/.howone/skills/hallmark/references/copy.md +182 -0
- package/templates/vite/.howone/skills/hallmark/references/custom-craft.md +626 -0
- package/templates/vite/.howone/skills/hallmark/references/custom-theme.md +367 -0
- package/templates/vite/.howone/skills/hallmark/references/design-md.md +116 -0
- package/templates/vite/.howone/skills/hallmark/references/export-formats.md +328 -0
- package/templates/vite/.howone/skills/hallmark/references/floating-nav.md +89 -0
- package/templates/vite/.howone/skills/hallmark/references/genres/atmospheric.md +69 -0
- package/templates/vite/.howone/skills/hallmark/references/genres/editorial.md +72 -0
- package/templates/vite/.howone/skills/hallmark/references/genres/modern-minimal.md +71 -0
- package/templates/vite/.howone/skills/hallmark/references/genres/playful.md +70 -0
- package/templates/vite/.howone/skills/hallmark/references/hero-enrichment.md +475 -0
- package/templates/vite/.howone/skills/hallmark/references/imagery-kit.md +170 -0
- package/templates/vite/.howone/skills/hallmark/references/interaction-and-states.md +208 -0
- package/templates/vite/.howone/skills/hallmark/references/layout-and-space.md +112 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/01-bento-grid.md +35 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/02-long-document.md +34 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/03-marquee-hero.md +31 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/04-stat-led.md +34 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/05-workbench.md +32 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/06-conversational-faq.md +33 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/07-manifesto.md +32 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/08-photographic.md +34 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/09-quote-led.md +32 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/10-specimen.md +32 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/11-catalogue.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/12-letter.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/13-index-first.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/14-narrative-workflow.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/15-split-studio.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/16-feature-stack.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/17-type-specimen.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/18-portfolio-grid.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/19-map-diagram.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/20-ecosystem-index.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures/21-component-playground.md +23 -0
- package/templates/vite/.howone/skills/hallmark/references/macrostructures.md +89 -0
- package/templates/vite/.howone/skills/hallmark/references/microinteractions.md +258 -0
- package/templates/vite/.howone/skills/hallmark/references/motion.md +109 -0
- package/templates/vite/.howone/skills/hallmark/references/preview-examples.md +49 -0
- package/templates/vite/.howone/skills/hallmark/references/responsive.md +138 -0
- package/templates/vite/.howone/skills/hallmark/references/slop-test.md +192 -0
- package/templates/vite/.howone/skills/hallmark/references/structure.md +160 -0
- package/templates/vite/.howone/skills/hallmark/references/study.md +509 -0
- package/templates/vite/.howone/skills/hallmark/references/themes/carnival.md +301 -0
- package/templates/vite/.howone/skills/hallmark/references/themes/cobalt.md +146 -0
- package/templates/vite/.howone/skills/hallmark/references/themes/hum.md +403 -0
- package/templates/vite/.howone/skills/hallmark/references/themes/lumen.md +478 -0
- package/templates/vite/.howone/skills/hallmark/references/typography.md +243 -0
- package/templates/vite/.howone/skills/hallmark/references/verbs/audit.md +25 -0
- package/templates/vite/.howone/skills/hallmark/references/verbs/redesign.md +269 -0
- package/templates/vite/.howone/skills/howone/01-architect/01-app-generation.md +209 -0
- package/templates/vite/.howone/skills/howone/01-architect/02-manifest-codegen.md +194 -0
- package/templates/vite/.howone/skills/howone/02-entity-schema/01-schema-design.md +523 -0
- package/templates/vite/.howone/skills/howone/02-entity-schema/02-schema-operations.md +329 -0
- package/templates/vite/.howone/skills/howone/02-entity-schema/03-access-models.md +151 -0
- package/templates/vite/.howone/skills/howone/02-entity-schema/04-query-contracts.md +123 -0
- package/templates/vite/.howone/skills/howone/02-entity-schema/05-ai-persistence-patterns.md +255 -0
- package/templates/vite/.howone/skills/howone/03-ai-capabilities/01-ai-capability-architecture.md +215 -0
- package/templates/vite/.howone/skills/howone/03-ai-capabilities/02-workflow-contract-rules.md +427 -0
- package/templates/vite/.howone/skills/howone/03-ai-capabilities/03-service-capability-catalog.md +304 -0
- package/templates/vite/.howone/skills/howone/03-ai-capabilities/04-workflow-operations.md +164 -0
- package/templates/vite/.howone/skills/howone/03-ai-capabilities/05-ai-feature-playbooks.md +275 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/01-client-setup.md +162 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/02-entity-operations.md +163 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/03-auth.md +418 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/04-react-integration.md +138 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/05-file-upload.md +112 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/06-raw-http.md +128 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/07-ai-action-calls.md +210 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/08-ai-manifest-handoff.md +90 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/09-extension-boundaries.md +226 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/10-workflow-execute-sse.md +138 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/11-entity-data-access-patterns.md +310 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/12-query-dsl-and-responses.md +237 -0
- package/templates/vite/.howone/skills/howone/04-app-sdk/13-credits.md +31 -0
- package/templates/vite/.howone/skills/howone/SKILL.md +256 -0
- package/templates/vite/.howone/skills/howone/agents/openai.yaml +4 -0
- package/templates/vite/.howone/skills/howone/references/audio-generation.md +30 -0
- package/templates/vite/.howone/skills/howone/references/audio-recognition.md +30 -0
- package/templates/vite/.howone/skills/howone/references/common-errors.md +27 -0
- package/templates/vite/.howone/skills/howone/references/finance.md +28 -0
- package/templates/vite/.howone/skills/howone/references/image-editing.md +30 -0
- package/templates/vite/.howone/skills/howone/references/image-generation.md +30 -0
- package/templates/vite/.howone/skills/howone/references/version-evidence.md +47 -0
- package/templates/vite/.howone/skills/howone/references/video-generation.md +35 -0
- package/templates/vite/.howone/skills/howone/scripts/verify-project.mjs +151 -0
- package/templates/vite/.prettierignore +7 -0
- package/templates/vite/.prettierrc +11 -0
- package/templates/vite/AGENTS.md +87 -0
- package/templates/vite/README.md +21 -0
- package/templates/vite/components.json +25 -0
- package/templates/vite/eslint.config.js +23 -0
- package/templates/vite/index.html +12 -0
- package/templates/vite/package.json +58 -0
- package/templates/vite/public/vite.svg +1 -0
- package/templates/vite/src/App.tsx +17 -0
- package/templates/vite/src/assets/react.svg +1 -0
- package/templates/vite/src/components/theme-provider.tsx +230 -0
- package/templates/vite/src/components/ui/accordion.tsx +79 -0
- package/templates/vite/src/components/ui/alert-dialog.tsx +197 -0
- package/templates/vite/src/components/ui/alert.tsx +76 -0
- package/templates/vite/src/components/ui/aspect-ratio.tsx +11 -0
- package/templates/vite/src/components/ui/avatar.tsx +110 -0
- package/templates/vite/src/components/ui/badge.tsx +49 -0
- package/templates/vite/src/components/ui/breadcrumb.tsx +122 -0
- package/templates/vite/src/components/ui/button-group.tsx +83 -0
- package/templates/vite/src/components/ui/button.tsx +67 -0
- package/templates/vite/src/components/ui/calendar.tsx +222 -0
- package/templates/vite/src/components/ui/card.tsx +103 -0
- package/templates/vite/src/components/ui/carousel.tsx +240 -0
- package/templates/vite/src/components/ui/chart.tsx +373 -0
- package/templates/vite/src/components/ui/checkbox.tsx +31 -0
- package/templates/vite/src/components/ui/collapsible.tsx +33 -0
- package/templates/vite/src/components/ui/combobox.tsx +299 -0
- package/templates/vite/src/components/ui/command.tsx +193 -0
- package/templates/vite/src/components/ui/context-menu.tsx +261 -0
- package/templates/vite/src/components/ui/dialog.tsx +168 -0
- package/templates/vite/src/components/ui/direction.tsx +22 -0
- package/templates/vite/src/components/ui/drawer.tsx +132 -0
- package/templates/vite/src/components/ui/dropdown-menu.tsx +269 -0
- package/templates/vite/src/components/ui/empty.tsx +104 -0
- package/templates/vite/src/components/ui/field.tsx +238 -0
- package/templates/vite/src/components/ui/hover-card.tsx +42 -0
- package/templates/vite/src/components/ui/input-group.tsx +154 -0
- package/templates/vite/src/components/ui/input-otp.tsx +87 -0
- package/templates/vite/src/components/ui/input.tsx +19 -0
- package/templates/vite/src/components/ui/item.tsx +196 -0
- package/templates/vite/src/components/ui/kbd.tsx +26 -0
- package/templates/vite/src/components/ui/label.tsx +22 -0
- package/templates/vite/src/components/ui/menubar.tsx +280 -0
- package/templates/vite/src/components/ui/native-select.tsx +61 -0
- package/templates/vite/src/components/ui/navigation-menu.tsx +164 -0
- package/templates/vite/src/components/ui/pagination.tsx +129 -0
- package/templates/vite/src/components/ui/popover.tsx +87 -0
- package/templates/vite/src/components/ui/progress.tsx +31 -0
- package/templates/vite/src/components/ui/radio-group.tsx +42 -0
- package/templates/vite/src/components/ui/resizable.tsx +50 -0
- package/templates/vite/src/components/ui/scroll-area.tsx +53 -0
- package/templates/vite/src/components/ui/select.tsx +192 -0
- package/templates/vite/src/components/ui/separator.tsx +26 -0
- package/templates/vite/src/components/ui/sheet.tsx +145 -0
- package/templates/vite/src/components/ui/sidebar.tsx +700 -0
- package/templates/vite/src/components/ui/skeleton.tsx +13 -0
- package/templates/vite/src/components/ui/slider.tsx +59 -0
- package/templates/vite/src/components/ui/sonner.tsx +47 -0
- package/templates/vite/src/components/ui/spinner.tsx +10 -0
- package/templates/vite/src/components/ui/switch.tsx +33 -0
- package/templates/vite/src/components/ui/table.tsx +114 -0
- package/templates/vite/src/components/ui/tabs.tsx +90 -0
- package/templates/vite/src/components/ui/textarea.tsx +18 -0
- package/templates/vite/src/components/ui/toggle-group.tsx +89 -0
- package/templates/vite/src/components/ui/toggle.tsx +45 -0
- package/templates/vite/src/components/ui/tooltip.tsx +57 -0
- package/templates/vite/src/hooks/use-mobile.ts +19 -0
- package/templates/vite/src/index.css +133 -0
- package/templates/vite/src/lib/sdk.ts +34 -0
- package/templates/vite/src/lib/utils.ts +6 -0
- package/templates/vite/src/main.tsx +14 -0
- package/templates/vite/tsconfig.app.json +32 -0
- package/templates/vite/tsconfig.json +13 -0
- package/templates/vite/tsconfig.node.json +26 -0
- package/templates/vite/vite.config.ts +14 -0
package/package.json
CHANGED
|
@@ -1,6 +1,57 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@howone/agent-cli",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"description": "
|
|
6
|
-
|
|
3
|
+
"version": "0.5.1",
|
|
4
|
+
"private": false,
|
|
5
|
+
"description": "HowOne CLI and agent skill installer for Codex and Claude.",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"sideEffects": false,
|
|
8
|
+
"main": "./bin/index.mjs",
|
|
9
|
+
"types": "./bin/index.d.mts",
|
|
10
|
+
"bin": {
|
|
11
|
+
"howone": "bin/index.mjs"
|
|
12
|
+
},
|
|
13
|
+
"files": [
|
|
14
|
+
"bin",
|
|
15
|
+
"skills",
|
|
16
|
+
"templates"
|
|
17
|
+
],
|
|
18
|
+
"exports": {
|
|
19
|
+
".": "./bin/index.mjs"
|
|
20
|
+
},
|
|
21
|
+
"publishConfig": {
|
|
22
|
+
"access": "public",
|
|
23
|
+
"registry": "https://registry.npmjs.org/"
|
|
24
|
+
},
|
|
25
|
+
"scripts": {
|
|
26
|
+
"build": "tsdown src/index.ts --format esm --platform node --out-dir bin --clean --dts",
|
|
27
|
+
"dev": "bun src/index.ts",
|
|
28
|
+
"lint": "biome check src templates",
|
|
29
|
+
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
30
|
+
"test": "bun test src"
|
|
31
|
+
},
|
|
32
|
+
"dependencies": {
|
|
33
|
+
"@astrojs/cli-kit": "^0.4.1",
|
|
34
|
+
"@clack/prompts": "^1.3.0",
|
|
35
|
+
"fs-extra": "^11.3.4",
|
|
36
|
+
"picocolors": "^1.1.1",
|
|
37
|
+
"validate-npm-package-name": "^7.0.2",
|
|
38
|
+
"yargs-parser": "^22.0.0"
|
|
39
|
+
},
|
|
40
|
+
"devDependencies": {
|
|
41
|
+
"@biomejs/biome": "^2.2.4",
|
|
42
|
+
"@types/bun": "^1.3.12",
|
|
43
|
+
"@types/fs-extra": "^11.0.4",
|
|
44
|
+
"@types/node": "^25.6.0",
|
|
45
|
+
"@types/validate-npm-package-name": "^4.0.2",
|
|
46
|
+
"@types/yargs-parser": "^21.0.3",
|
|
47
|
+
"tsdown": "^0.21.10",
|
|
48
|
+
"typescript": "^5.7.3"
|
|
49
|
+
},
|
|
50
|
+
"repository": {
|
|
51
|
+
"type": "git",
|
|
52
|
+
"url": "git+ssh://git@gitlab.howone.dev:30022/bus/howone-cli.git"
|
|
53
|
+
},
|
|
54
|
+
"engines": {
|
|
55
|
+
"node": "^20.19.0 || ^22.12.0 || >=23"
|
|
56
|
+
}
|
|
57
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Apps
|
|
2
|
+
|
|
3
|
+
```bash
|
|
4
|
+
howone apps list --json # all apps the user owns
|
|
5
|
+
howone apps show <app> --json # status, preview URL, production URL, edit lock
|
|
6
|
+
howone apps create "<name>" --json # new app + HowOne template in ./<id> (--target <dir> to choose)
|
|
7
|
+
howone apps pull <app> [dir] --json # download an existing app's code into dir
|
|
8
|
+
howone preview <app> --json # wake and wait for a ready preview; no pull required
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
`<app>` is the app id from `apps list` (also accepted: the short id in its URLs).
|
|
12
|
+
|
|
13
|
+
## Finding the app the user means
|
|
14
|
+
|
|
15
|
+
When the user names an app ("my bookkeeping app"), run `howone apps list --json` and match
|
|
16
|
+
on `name`. If more than one matches, or none, ask — do not guess.
|
|
17
|
+
|
|
18
|
+
## Working directory
|
|
19
|
+
|
|
20
|
+
`howone apps pull <app> <dir>` writes the code and records the app id in
|
|
21
|
+
`<dir>/.howone/cli.json` (local only, never uploaded). Inside that directory every command
|
|
22
|
+
knows the app, so `--app` can be omitted. From anywhere else, pass `--app <app>`.
|
|
23
|
+
|
|
24
|
+
To start from scratch: `howone apps create "<name>"` creates the app on HowOne and writes the
|
|
25
|
+
HowOne template into a new directory, already bound to the app. Write the code there and
|
|
26
|
+
`howone push`. Do not scaffold a project by hand.
|
|
27
|
+
|
|
28
|
+
`pull` refuses to overwrite a non-empty directory unless `--force` is given. If the user has
|
|
29
|
+
local changes, commit them (git) before pulling over them.
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Develop, preview, publish
|
|
2
|
+
|
|
3
|
+
## View an existing preview
|
|
4
|
+
|
|
5
|
+
When the user asks to see an App preview, wake it through CLI before opening the returned URL:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
howone preview <app> --json # works without pulling the App or a local project
|
|
9
|
+
howone preview --json # inside an already bound App directory
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
This waits for the sandbox and development server to be ready and returns the current
|
|
13
|
+
`previewUrl`. It does not sync files, build, publish, or take an edit lock. `apps show` and
|
|
14
|
+
`status` return stored URLs and do not wake previews. Use the URL from `preview` instead of
|
|
15
|
+
reopening a stale URL or asking the user to open the HowOne editor first.
|
|
16
|
+
|
|
17
|
+
If an App has a ready saved version but no preview record yet, `howone preview` initializes the
|
|
18
|
+
preview from its saved workspace and waits until it is ready. This is read-only: it does not
|
|
19
|
+
sync local files, create a version, build a release, publish, or take an edit lock. If the App
|
|
20
|
+
has no ready saved code, follow the user's intent:
|
|
21
|
+
|
|
22
|
+
- If the user asked you to build or change the App, continue that coding task. Pull an existing
|
|
23
|
+
App with `howone apps pull <app> <dir> --json`, inspect its code and project instructions,
|
|
24
|
+
implement the requested work, then run the first `howone push -m "<what you built>" --json`.
|
|
25
|
+
For a new App the user explicitly asked you to build, use `howone apps create "<name>" --json`
|
|
26
|
+
to scaffold the HowOne template before implementing the requested work. The first push saves
|
|
27
|
+
the code as a version and attempts to start its preview.
|
|
28
|
+
- If the user only asked to view a preview and the App has no saved code, report that there is
|
|
29
|
+
nothing to preview yet and ask what they want built. Do not invent an app, create content, or
|
|
30
|
+
push an empty project just to produce a URL.
|
|
31
|
+
|
|
32
|
+
If the App does have a ready saved version but `preview` still returns
|
|
33
|
+
`E_PREVIEW_UNAVAILABLE`, inspect `howone apps show <app> --json`. Treat this as a Studio
|
|
34
|
+
deployment or preview initialization error and report the result; do not create another version
|
|
35
|
+
with `push` just to work around it. Report `E_PREVIEW_FAILED` with its details. Older servers
|
|
36
|
+
may return HTTP 404 for `/preview/wake`; report that Studio needs the matching preview endpoint.
|
|
37
|
+
|
|
38
|
+
## The loop
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
howone push -m "<what changed>" --json # upload changes, build on HowOne, return preview URL
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
`push` takes the app's edit lock, uploads every changed file (respecting `.gitignore`), seals a
|
|
45
|
+
new version, starts the cloud preview, runs a real build and returns the result. When `push`
|
|
46
|
+
took the lock itself it gives it back at the end (pass `--keep-lock` to hold on to it):
|
|
47
|
+
|
|
48
|
+
```json
|
|
49
|
+
{ "ok": true, "version": { "id": "...", "number": 12 }, "build": { "status": "succeeded" },
|
|
50
|
+
"previewUrl": "https://..." }
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
On a failed build the command exits non-zero with `error.code` `E_BUILD_FAILED`;
|
|
54
|
+
`error.details.build` holds the failing step and the raw log. The version is still saved — fix
|
|
55
|
+
the code and push again. When `ok` is true and `build.status` is `succeeded`, check `previewUrl`
|
|
56
|
+
before reporting preview success. If it is null or empty, call `howone preview <app> --json`:
|
|
57
|
+
Studio may have saved the ready version even when the first preview initialization failed, and
|
|
58
|
+
the preview command can initialize it from that saved workspace. Do not push again just to
|
|
59
|
+
retry preview. Show the returned URL when either command provides a ready preview; otherwise
|
|
60
|
+
report the preview error separately from the successful version/build result.
|
|
61
|
+
|
|
62
|
+
If HowOne has a newer version than the one this directory was pulled from, `push` stops with
|
|
63
|
+
`E_STALE_BASE`: commit local work, `howone apps pull <app> . --force`, merge, push again.
|
|
64
|
+
|
|
65
|
+
## Live mode
|
|
66
|
+
|
|
67
|
+
For iterative UI work, start `howone dev` in the background and leave it running:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
howone dev # takes the edit lock, syncs every save to the cloud sandbox
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
The sandbox preview reloads on each save (the URL is printed at start). `push` still has to be
|
|
74
|
+
run to create a version. Stop `dev` (Ctrl-C) when done; it gives the lock back.
|
|
75
|
+
|
|
76
|
+
## Status and the edit lock
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
howone status --json # lock holder, latest version, build state, preview URL
|
|
80
|
+
howone release --json # give the edit lock back to the platform now
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
When you finish working on an app, run `howone release` so the user can keep editing it in
|
|
84
|
+
the HowOne web app.
|
|
85
|
+
|
|
86
|
+
## Publish (ask first)
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
howone publish --yes --json # publish the latest version
|
|
90
|
+
howone publish 12 --yes --json # publish version 12
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Only after the user explicitly agreed, having seen the preview.
|
|
94
|
+
|
|
95
|
+
## Error codes
|
|
96
|
+
|
|
97
|
+
| code | meaning | do |
|
|
98
|
+
|---|---|---|
|
|
99
|
+
| `E_AUTH_REQUIRED` | not logged in / token revoked | ask the user to run `howone login` |
|
|
100
|
+
| `E_LOCKED_BY_PLATFORM` | the in-platform agent is editing | stop; tell the user |
|
|
101
|
+
| `E_LOCKED` | another local session holds the app | stop; tell the user |
|
|
102
|
+
| `E_STALE_BASE` | HowOne has a newer version than your copy | pull and merge first |
|
|
103
|
+
| `E_LOCK_LOST` | the user took the app back in the web app | stop; run `howone apps pull` before any new edit |
|
|
104
|
+
| `E_FILES_REJECTED` | symlink or file > 5MB | remove it or add it to `.gitignore` |
|
|
105
|
+
| `E_BUILD_FAILED` | build failed | read `details.build.log`, fix, push again |
|
|
106
|
+
| `E_SEAL_FAILED` | version rejected before build (functions, entities) | read `details`, fix, push again |
|
|
107
|
+
| `E_NOT_FOUND` | unknown app / version | re-check with `howone apps list` |
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Workflows
|
|
2
|
+
|
|
3
|
+
HowOne hosts ready-made AI workflows (image/video/audio generation, recognition, document and
|
|
4
|
+
data processing…). They can be run directly — no app needed. Runs are billed to the user's
|
|
5
|
+
HowOne credits.
|
|
6
|
+
|
|
7
|
+
Use this track for the published Workflow catalog. For a named existing App or registered
|
|
8
|
+
capability, start with `05-capabilities.md`; a package and a Workflow have different identifiers.
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
howone workflows search "<what the user wants, in their words>" --json
|
|
12
|
+
howone workflows show <app-short-id>/<workflow-id> --json # inputs, outputs, cost hints
|
|
13
|
+
howone workflows run <app-short-id>/<workflow-id> --input '{"prompt":"..."}' --json
|
|
14
|
+
howone workflows run <app-short-id>/<workflow-id> --input input.json --output result.json --json
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Steps:
|
|
18
|
+
|
|
19
|
+
1. `search` with the user's own description. Pick the best match by `name` and `description`;
|
|
20
|
+
if several fit, show them and ask.
|
|
21
|
+
2. Use the returned workflow reference exactly as returned. App workflow references use the
|
|
22
|
+
App **short ID** and workflow ID (`<app-short-id>/<workflow-id>`), never the App UUID alone.
|
|
23
|
+
3. `show` it and build the input **only** from its `inputs` schema. Ask the user for required
|
|
24
|
+
values you do not have — do not invent them.
|
|
25
|
+
4. `run` it. Progress is streamed to stderr; the final JSON on stdout holds the outputs (URLs
|
|
26
|
+
for generated media). Give the user the outputs, not the raw JSON.
|
|
27
|
+
|
|
28
|
+
An empty search means this Workflow catalog has no matching result. If the user named an App
|
|
29
|
+
or capability, check its Registry package using `05-capabilities.md` before concluding it cannot
|
|
30
|
+
be called. Do not guess a workflow ID, use an App UUID with `show`, or open the App preview to
|
|
31
|
+
work around an empty search. An App capability can exist in draft or Registry metadata while
|
|
32
|
+
its EAX Workflow Release is still unpublished.
|
|
33
|
+
|
|
34
|
+
A run that fails comes back with `ok: false`; `error.code` `E_INSUFFICIENT_CREDITS` means the
|
|
35
|
+
user must top up — tell them, do not retry.
|
|
36
|
+
|
|
37
|
+
## Defining workflows inside an app
|
|
38
|
+
|
|
39
|
+
An app's AI features are workflows that HowOne generates from a **capability contract**
|
|
40
|
+
(name, description, input schema, output schema). Write the contract, HowOne builds the
|
|
41
|
+
workflow, the app calls it through the SDK.
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
howone ai get --json # current capability contracts of the app
|
|
45
|
+
howone ai apply ai-patch.json --json # create/update contracts (draft of this edit session)
|
|
46
|
+
howone ai sync --json # write .howone/ai/* into this directory
|
|
47
|
+
howone workflows create <capabilityName> --json # HowOne generates the workflow
|
|
48
|
+
howone workflows update <capabilityName> --prompt "<change>" --json
|
|
49
|
+
howone push -m "..." --json # makes contracts + code a version
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
1. Design the contract following `coding/03-ai-capabilities/01-ai-capability-architecture.md`
|
|
53
|
+
and `02-workflow-contract-rules.md`; the patch format is `{ "operations": [...] }` with
|
|
54
|
+
`create_capability` / `update_capability` / `delete_capability`.
|
|
55
|
+
2. `ai sync` pulls the generated `.howone/ai` files into this directory — keep them, they are
|
|
56
|
+
what the SDK bindings read. Run it again after every `ai apply`.
|
|
57
|
+
3. `workflows create` starts generation and returns a job ID. Do other work that does not need
|
|
58
|
+
the generated workflow binding, then check the job with:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
howone workflows status <jobId> --app <app-short-id> --wait --json
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
The status API reports both EAX execution and Studio Release promotion. EAX may finish before
|
|
65
|
+
Studio exposes the workflow; `status: "running"` with `eaxStatus: "completed"` means Studio is
|
|
66
|
+
still finalizing it. Only `status: "completed"` means it is ready to sync. `--wait` polls for up
|
|
67
|
+
to 10 minutes by default; use `--timeout <seconds>` to change that. If it times out, rerun the
|
|
68
|
+
status command with the same job ID. Do not use `workflows show` to check an in-progress authoring
|
|
69
|
+
job: that command searches the published workflow catalog and can return 404 before promotion.
|
|
70
|
+
Then run `ai sync`, inspect the manifest, and `push`.
|
|
71
|
+
4. All of this happens in the edit session's draft, like schema changes: push soon after.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Functions and data
|
|
2
|
+
|
|
3
|
+
How to write functions and entities is in `coding/03-ai-capabilities/06-functions.md` and
|
|
4
|
+
`coding/02-entity-schema/`. This page is only the CLI side.
|
|
5
|
+
|
|
6
|
+
## Functions (`functions/<name>/` in the app)
|
|
7
|
+
|
|
8
|
+
Functions are deployed with the app by `howone push`. Around that:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
howone fn list --json # functions of the latest version
|
|
12
|
+
howone fn secrets list --json # names only, never values
|
|
13
|
+
howone fn secrets set <NAME> --value-stdin --json # pipe the value in; never put it in a file
|
|
14
|
+
howone fn secrets delete <NAME> --json
|
|
15
|
+
howone fn test <name> --input '{...}' --json
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
`fn test` runs the function from the **latest pushed version** in test mode: writes are
|
|
19
|
+
simulated, reads are real, and external calls/LLM/tools are answered by that version's
|
|
20
|
+
`functions/<name>/fixtures.json`. Change fixtures → push → test.
|
|
21
|
+
|
|
22
|
+
Ask the user for secret values; pass them through stdin
|
|
23
|
+
(`printf %s "$VALUE" | howone fn secrets set NAME --value-stdin`).
|
|
24
|
+
|
|
25
|
+
## Entity schema
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
howone schema get --json # current entities of the app
|
|
29
|
+
howone schema apply patch.json --json # apply a schema patch (same format the platform agent uses)
|
|
30
|
+
howone schema sync --json # write the entity artifacts (.howone/database) here
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Write the patch as `{ "operations": [...] }` following
|
|
34
|
+
`coding/02-entity-schema/02-schema-operations.md`. A rejected patch returns `E_SCHEMA_REJECTED`
|
|
35
|
+
with the validation errors in `details`; fix and re-apply.
|
|
36
|
+
|
|
37
|
+
Schema changes go into the draft of the current edit session (both commands take the edit
|
|
38
|
+
lock) and become part of the app with the next `howone push` — push soon after applying; an
|
|
39
|
+
abandoned session (no activity for 15 minutes) drops its draft. Patches that can delete data
|
|
40
|
+
(hard entity delete, removing data, changing a field type) stop with `E_CONFIRMATION_REQUIRED`:
|
|
41
|
+
ask the user, then re-run with `--allow-destructive`.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Callable capabilities
|
|
2
|
+
|
|
3
|
+
Registry capabilities are callable packages exposed through the HowOne capability API. They
|
|
4
|
+
are different from the published Workflow catalog:
|
|
5
|
+
|
|
6
|
+
- `workflows search/show/run` uses `<app-short-id>/<workflow-id>` and lists published workflow
|
|
7
|
+
releases.
|
|
8
|
+
- `capabilities list/inspect/run` uses `<package>` or `<package>.<action>` and lists registered
|
|
9
|
+
capability packages.
|
|
10
|
+
|
|
11
|
+
For a named App, list private packages and match the name/description or `sourceProjectId`
|
|
12
|
+
against `howone apps list --json`. Inspect the returned package slug (or ID) to discover the
|
|
13
|
+
action reference and input schema; do not use an internal AI capability name as the package
|
|
14
|
+
identifier. Build the input from that schema and the user's request, then run the returned
|
|
15
|
+
`<package>.<action>` reference. Return the generated content or media to the user.
|
|
16
|
+
|
|
17
|
+
Use the saved login origin by default. For an explicitly selected instance, pass that origin
|
|
18
|
+
consistently. For example:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
howone capabilities list \
|
|
22
|
+
--scope private \
|
|
23
|
+
--api-url https://<instance>.howone.dev \
|
|
24
|
+
--json
|
|
25
|
+
|
|
26
|
+
howone capabilities inspect <package-slug> \
|
|
27
|
+
--scope private \
|
|
28
|
+
--api-url https://<instance>.howone.dev \
|
|
29
|
+
--json
|
|
30
|
+
|
|
31
|
+
howone run <package>.<action> \
|
|
32
|
+
--input '{"idea":"..."}' \
|
|
33
|
+
--api-url https://<instance>.howone.dev \
|
|
34
|
+
--json
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
`howone login` stores the personal CLI token locally; current CLI versions reuse that token for
|
|
38
|
+
registry requests. A private registry request may also use `HOWONE_API_TOKEN` or `--token`.
|
|
39
|
+
Never print or ask the user to paste the token. If the command reports `E_AUTH_REQUIRED`, run
|
|
40
|
+
`howone whoami --json` to verify login and report the missing credential instead of opening a
|
|
41
|
+
browser or switching to an unrelated App preview.
|
|
42
|
+
|
|
43
|
+
Capability metadata being `active` does not prove that its source App has a published Workflow
|
|
44
|
+
Release. If `howone run` returns `This app has no published workflows`, the capability is
|
|
45
|
+
registered but its runtime release is not published; report that state and do not retry in a
|
|
46
|
+
loop.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: howone
|
|
3
|
+
description: 'Use when the user wants to build, change, preview or publish one of their HowOne apps from this machine, or wants to find and run a HowOne/EAX AI workflow or callable capability (image, video, audio, document, data workflows). Covers the `howone` CLI: apps list/create/pull, dev sync to the cloud sandbox, push (platform build + preview), publish, functions, entity schema, workflows, and capabilities. Not for apps unrelated to HowOne.'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# HowOne
|
|
7
|
+
|
|
8
|
+
The user has a HowOne account. Everything goes through the `howone` CLI; use
|
|
9
|
+
`howone whoami --json` to check the login and API origin. Code is written **here, on this machine**; HowOne builds,
|
|
10
|
+
previews and hosts it. Always pass `--json` and read the JSON result — never scrape the
|
|
11
|
+
human-readable output.
|
|
12
|
+
|
|
13
|
+
If `howone` is not on PATH, use `npx --yes @howone/agent-cli@<version>` with the version in
|
|
14
|
+
`.howone-cli.json` next to this file.
|
|
15
|
+
|
|
16
|
+
## Pick the track
|
|
17
|
+
|
|
18
|
+
| The user wants to… | Read |
|
|
19
|
+
|---|---|
|
|
20
|
+
| see their apps, start a new one, get an app's code | `01-apps.md` |
|
|
21
|
+
| change an app and see the result, publish it | `02-develop.md` |
|
|
22
|
+
| view an existing App preview without editing | `02-develop.md` → *View an existing preview* |
|
|
23
|
+
| run an AI workflow without building an app | `03-workflows.md` |
|
|
24
|
+
| give an app an AI feature (define a workflow) | `03-workflows.md` → *Defining workflows* |
|
|
25
|
+
| find or run a registered callable capability | `05-capabilities.md` |
|
|
26
|
+
| use an existing named App to generate a result | `05-capabilities.md` first; find its callable package |
|
|
27
|
+
| add backend logic, secrets, data entities | `04-functions-and-data.md` |
|
|
28
|
+
| write the app's code (SDK, entities, AI features) | `coding/SKILL.md` |
|
|
29
|
+
|
|
30
|
+
When the user wants a generated result from an existing App, use its CLI capability or workflow.
|
|
31
|
+
Opening the App preview is for requests to view or interact with its UI. CLI login and browser
|
|
32
|
+
sessions are separate; a preview login screen is not evidence that the CLI needs login.
|
|
33
|
+
|
|
34
|
+
`howone login` saves both the API origin and personal token. Capability and workflow commands
|
|
35
|
+
reuse them without exporting a token. Keep the user's chosen origin; explicit `--api-url` and
|
|
36
|
+
`HOWONE_API_URL` override the saved origin, and saved tokens are used only with their matching
|
|
37
|
+
origin. On an auth error, check `whoami` against the same origin before requesting login. On a
|
|
38
|
+
network error, report the CLI error instead of switching origins or opening an App preview.
|
|
39
|
+
|
|
40
|
+
## Rules that always apply
|
|
41
|
+
|
|
42
|
+
1. **One editor at a time.** An app is edited either here or by the HowOne in-platform agent,
|
|
43
|
+
never both. `howone dev` / `howone push` take the app's edit lock. If the lock is held by
|
|
44
|
+
the platform, stop and tell the user — do not retry in a loop.
|
|
45
|
+
2. **Never publish without asking.** `howone publish` puts the app in front of real users.
|
|
46
|
+
Show the user the preview URL and get an explicit yes first.
|
|
47
|
+
3. **The platform builds, not you.** Do not commit `dist/` or `node_modules/`; do not run a
|
|
48
|
+
production build to "check". `howone push` returns the real build result — fix what it
|
|
49
|
+
reports and push again.
|
|
50
|
+
4. **No secrets in code.** Credentials go through `howone fn secrets set`, never into files.
|
|
51
|
+
5. **Errors are data.** Every failure comes back as `{ ok: false, error: { code, message, details } }`.
|
|
52
|
+
Read `code` and act on it (see the table in `02-develop.md`); report what you could not fix.
|