{"id":50607220,"url":"https://github.com/sawfwair/dkcli","last_synced_at":"2026-06-06T00:03:54.472Z","repository":{"id":355938935,"uuid":"1227326870","full_name":"sawfwair/dkcli","owner":"sawfwair","description":"Proof-driven design CLI for OKLCH palettes, APCA contrast, fluid scales, motion curves, layout audits, tokens, and Svelte components.","archived":false,"fork":false,"pushed_at":"2026-05-05T22:55:49.000Z","size":517,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-05T14:07:35.773Z","etag":null,"topics":["apca","cli","design-system","oklch","svelte","typography","vitepress"],"latest_commit_sha":null,"homepage":"https://dkcli.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sawfwair.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-02T14:28:30.000Z","updated_at":"2026-05-13T16:47:52.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sawfwair/dkcli","commit_stats":null,"previous_names":["sawfwair/dkcli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sawfwair/dkcli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sawfwair%2Fdkcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sawfwair%2Fdkcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sawfwair%2Fdkcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sawfwair%2Fdkcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sawfwair","download_url":"https://codeload.github.com/sawfwair/dkcli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sawfwair%2Fdkcli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33964367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-05T02:00:06.157Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apca","cli","design-system","oklch","svelte","typography","vitepress"],"created_at":"2026-06-06T00:03:53.696Z","updated_at":"2026-06-06T00:03:54.466Z","avatar_url":"https://github.com/sawfwair.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DesignKit CLI\n\n[![CI](https://github.com/sawfwair/dkcli/actions/workflows/ci.yml/badge.svg)](https://github.com/sawfwair/dkcli/actions/workflows/ci.yml)\n[![Packages](https://github.com/sawfwair/dkcli/actions/workflows/packages.yml/badge.svg)](https://github.com/sawfwair/dkcli/actions/workflows/packages.yml)\n[![Docs](https://github.com/sawfwair/dkcli/actions/workflows/docs.yml/badge.svg)](https://github.com/sawfwair/dkcli/actions/workflows/docs.yml)\n[![npm](https://img.shields.io/npm/v/%40dkcli%2Fcli?color=%23af6100)](https://www.npmjs.com/package/@dkcli/cli)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/public/readme-hero.svg\" alt=\"DesignKit CLI turns a seed color into palette, type, motion, layout, and proof outputs.\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\nProof-driven design tooling for teams that want interface decisions to leave evidence behind.\n\nDesignKit ships a deterministic CLI and package workspace for OKLCH palettes, APCA contrast, fluid scales, motion curves, optical corrections, layout rails, composition scoring, typography recommendations, CSS audits, token emission, and Svelte 5 component recipes.\n\n## Docs\n\n- Public site: [dkcli.com](https://dkcli.com)\n- GitHub Pages workflow: [.github/workflows/docs.yml](.github/workflows/docs.yml)\n- VitePress source: [docs/](docs/)\n- Docs theme proof artifacts: [docs/.vitepress/theme/generated](docs/.vitepress/theme/generated)\n\nThe docs site uses DesignKit itself. `pnpm docs:build` runs `scripts/generate-docs-design.mjs`, which invokes the local `dk` CLI to generate the docs palette, fluid scale, typography rhythm, motion curve, and proof JSON before VitePress builds.\n\n## Install\n\n```bash\nnpm install -g @dkcli/cli\n```\n\nOr run it one-off:\n\n```bash\nnpx @dkcli/cli --help\n```\n\nInside this repository, use the source-owned wrapper:\n\n```bash\npnpm install\npnpm dk --help\n```\n\n## Quick Start\n\n```bash\ndk perfect --seed \"#D96F32\" --ratio perfect-fourth --motion snappy\ndk palette \"#D96F32\" --harmony split-complementary --json\ndk scale --fluid --ratio perfect-fourth --base-min 15 --base-max 19\ndk text --font 18 --measure 680 --contrast 72\ndk audit --css app.css\n```\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/public/readme-proof.svg\" alt=\"A generated DesignKit proof snapshot with palette swatches, APCA passes, layout metrics, and motion output.\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\n## Packages\n\n- `@dkcli/cli`: the `dk` and `dkcli` command line tools.\n- `@dkcli/core`: framework-agnostic math, proofs, specs, and recipe compilation.\n- `@dkcli/tokens`: compiled themes, token aliases, and CSS/JSON emitters.\n- `@dkcli/components`: Svelte 5 components backed by DesignKit recipes and themes.\n\n## Command Families\n\n| Family | Commands | Purpose |\n| --- | --- | --- |\n| Proof | `perfect`, `contrast`, `target`, `audit` | Generate evidence for readability, interaction burden, CSS quality, and complete design states. |\n| Foundations | `palette`, `distinct`, `scale`, `text`, `typeset`, `linebreak` | Build color, spacing, and typography systems with measurable constraints. |\n| Motion | `ease`, `jerk` | Convert spring physics and minimum-jerk motion into CSS-ready curves. |\n| Layout | `layout`, `compose`, `saliency`, `future` | Solve rails, score composition, and explore content topology. |\n| Product | `components`, `cms` | Verify component recipes and manage hosted DKCMS content. |\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/public/readme-map.svg\" alt=\"DesignKit command families flowing into CLI, core, tokens, and components packages.\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\n## Local Development\n\nUse Node 22 or newer and pnpm 10.33.0.\n\n```bash\ncorepack enable\ncorepack prepare pnpm@10.33.0 --activate\npnpm install\npnpm lint\npnpm check:strict\npnpm test\npnpm build\n```\n\n## Docs Development\n\n```bash\npnpm docs:tokens\npnpm docs:dev\npnpm docs:build\npnpm docs:preview\n```\n\n`docs:tokens` is safe in a fresh checkout: it builds the workspace packages required by the local CLI before generating docs tokens.\n\n## Release Checks\n\nRun the full public release gate before publishing packages or tagging a release:\n\n```bash\npnpm release:verify\n```\n\nThis runs linting, strict checks, tests, builds, package verification, dry packs, package-content checks, and starter verification.\n\n## Architecture\n\n- `src/bin/dk.ts` is the publishable CLI entrypoint compiled into `dist/bin/dk.js`.\n- `bin/dk.js` is the local development wrapper used by docs and source commands.\n- `src/lib/dk` contains deterministic CLI helpers and command implementations.\n- `src/lib/dkcms` contains typed payload helpers used by `dk cms` commands.\n- `packages/core` contains framework-agnostic design math and proof contracts.\n- `packages/tokens` emits theme tokens and CSS/JSON artifacts.\n- `packages/components` contains the Svelte component package.\n- `examples/svelte-starter` verifies the published package tarballs in a small consumer app.\n\n## Contributing And Security\n\n- Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a PR.\n- Report sensitive security issues through [SECURITY.md](SECURITY.md).\n- Do not commit `.env` files, `.npmrc`, service tokens, or deployment overlays.\n\nReleased under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsawfwair%2Fdkcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsawfwair%2Fdkcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsawfwair%2Fdkcli/lists"}