{"_id":"@amiirbazzii/designflow","name":"@amiirbazzii/designflow","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@amiirbazzii/designflow","version":"0.1.0","description":"AI workflows that turn ideas into results, from your terminal","type":"module","main":"./dist/index.js","types":"./dist/index.d.ts","bin":{"designflow":"dist/main.js"},"exports":{".":{"import":"./dist/index.js","types":"./dist/index.d.ts"}},"scripts":{"build":"bun build src/main.ts --target=node --format=esm --outfile=dist/main.js","start":"bun run src/main.ts","lint":"eslint src","typecheck":"tsc --noEmit","test":"bun test","prepublishOnly":"bun run build","smoke":"bash ../../scripts/cli-smoke-test.sh"},"keywords":["designflow","workflow","ai","cli"],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/amiirbazzii/designflow.git","directory":"apps/designflow-cli"},"engines":{"node":">=18"},"devDependencies":{"@designflow/agents":"workspace:*","@designflow/core":"workspace:*","@designflow/model-provider-openrouter":"workspace:*","@designflow/models":"workspace:*","@designflow/product":"workspace:*","@designflow/sdk":"workspace:*","@designflow/storage-file":"workspace:*","@designflow/tools":"workspace:*","@designflow/workers":"workspace:*","@designflow/workflow-design-to-code":"workspace:*","@designflow/workflow-qa-review":"workspace:*","@designflow/workflow-research-analysis":"workspace:*","@designflow/workflow-product-brief":"workspace:*","zod":"^3.24.0"},"_id":"@amiirbazzii/designflow@0.1.0","gitHead":"18eef1b751afa883417d4a7b8afa33a04fa55bdc","bugs":{"url":"https://github.com/amiirbazzii/designflow/issues"},"homepage":"https://github.com/amiirbazzii/designflow#readme","_nodeVersion":"22.23.1","_npmVersion":"10.9.8","dist":{"integrity":"sha512-Rd9qSffT4BvVob1KG1khoJQOneKcuYPeUlxM9Ms4ue8jZtgXYq+m/OhWEM0E8yibbqkymnk0sdARUg0xtNRk+g==","shasum":"c562d3c4adfa124bc48dcf6d838da05751144ce8","tarball":"https://registry.npmjs.org/@amiirbazzii/designflow/-/designflow-0.1.0.tgz","fileCount":4,"unpackedSize":692010,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCICL28eO9CUiPnnntOH6maZI/Z+Uu0ja2Ek+fEi1Rqs7jAiEA+XkWCXVRC0tsJn8s2Ijfg8mBLhAnPOx5KhLvbajzY6Q="}]},"_npmUser":{"name":"amiirbazzii","email":"Amiirbazzii@gmail.com"},"directories":{},"maintainers":[{"name":"amiirbazzii","email":"Amiirbazzii@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/designflow_0.1.0_1785652509019_0.8706139031153655"},"_hasShrinkwrap":false}},"time":{"created":"2026-08-02T06:35:08.829Z","0.1.0":"2026-08-02T06:35:09.169Z","modified":"2026-08-02T06:35:09.335Z"},"maintainers":[{"name":"amiirbazzii","email":"Amiirbazzii@gmail.com"}],"description":"AI workflows that turn ideas into results, from your terminal","homepage":"https://github.com/amiirbazzii/designflow#readme","keywords":["designflow","workflow","ai","cli"],"repository":{"type":"git","url":"git+https://github.com/amiirbazzii/designflow.git","directory":"apps/designflow-cli"},"bugs":{"url":"https://github.com/amiirbazzii/designflow/issues"},"license":"MIT","readme":"# designflow\n\nYour AI workforce in the terminal.\n\n## Install\n\n```bash\nnpm install -g designflow\n```\n\n## First run\n\nThe first invocation introduces itself and lays out its application directory:\n\n```\n$ designflow\n\nWelcome to DesignFlow.\n\nYour AI workforce in the terminal.\n\n──────────────────────────────────────────────\n\nSet up  ~/.designflow\n\n  config.json    settings you can edit\n  history/       your previous runs\n  cache/         working space\n\nNothing leaves this machine. There is no account to create.\n```\n\nIt then continues straight into the application. Later runs skip the welcome.\n\n## Use\n\n```bash\ndesignflow                        # interactive\ndesignflow list                   # available AI workers\ndesignflow run design-engineer    # put a worker to work\ndesignflow history                # previous runs\ndesignflow settings               # where things are kept\ndesignflow --version\ndesignflow --help\n```\n\nInteractive mode is the main menu:\n\n```\nDesignFlow AI\n──────────────────────────────────────────────\n\nOptions:\n\n  1. Use an AI Worker\n  2. View History\n  3. Settings\n  4. Exit\n```\n\nOption 1 reads the worker registry, so a worker package you install appears\nwithout an upgrade. Scriptable too:\n\n```bash\nprintf 'homepage.fig\\nreact\\nbrand/Header, brand/Footer\\napprove\\n' \\\n  | designflow run design-engineer\n```\n\nBlank answers take the placeholder, so you can press through the form.\n\n## Configuration\n\n`~/.designflow/config.json`, written on first run:\n\n```json\n{\n  \"version\": 1,\n  \"firstRunCompleted\": true,\n  \"environment\": \"local\",\n  \"databasePath\": \"history/runs.json\",\n  \"settings\": {}\n}\n```\n\nEdit it by hand — `settings` shows you the path. Three properties hold:\n\n- **Safe reading.** A broken file never blocks a run. Values that parse are\n  kept field by field, so one bad setting costs one setting.\n- **Safe writing.** Written to a temp file and renamed, so an interrupted write\n  leaves the previous config intact.\n- **Migration-friendly.** `version` is an open integer, so a file from a newer\n  CLI is read rather than discarded. Additive settings go in `settings`.\n\nThere is no account, no API key and no endpoint to configure. Set\n`DESIGNFLOW_HOME` to move the whole directory.\n\nNo native modules, no database server — the CLI runs on any Node 18+.\n\n## When something fails\n\nErrors say what went wrong and what to try, and print no stack trace:\n\n```\n$ DESIGNFLOW_HOME=/some/file/home designflow list\n\nDesignFlow's directory path runs through a file, not a folder.\n\nCheck DESIGNFLOW_HOME — one of the names in that path is a file.\n```\n\n`DESIGNFLOW_DEBUG=1` adds the full trace when you need to diagnose one.\n\n## Architecture\n\n```\ndesignflow CLI → @designflow/product → workflows → engine\n       ↑\n  @designflow/workers   (the worker catalogue: metadata only)\n```\n\nA worker is a product-facing name wrapping one or more workflows. `designflow\nlist` shows workers; workflow ids are still accepted by `run` so nothing is\nunreachable, but they are no longer part of the vocabulary.\n\n`src/services/cli-runner.ts` is the composition root and the only file that\nimports the engine. Commands and rendering speak `@designflow/product` alone; a\ntest enforces that. `src/services/home.ts` does the first-run filesystem work\nand prints nothing — the onboarding text lives in `src/ui/terminal.ts`.\n\nFull rationale: `docs/adr/20260728-designflow-cli.md` and\n`docs/adr/20260730-first-run-experience.md`.\n","readmeFilename":"README.md","_rev":"1-65b6bb2f49e919b271a5998b17eefc9a"}