Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 3.91 KB

README.md

File metadata and controls

75 lines (47 loc) · 3.91 KB

@db-ux/agent-cli

Apache 2.0 license badge code style: prettier Conventional Commits PRs Welcome

Usage

We provide a command-line interface (CLI) tool that copies the @db-ux documentation to your repository, making it available to AI agents.

Running the CLI Tool

Use this command in your repository:

npx @db-ux/agent-cli

Or with pnpm:

pnpm i @db-ux/agent-cli --save-dev
pnpm exec agent-cli

The DB UX Design System documentation will be added to (or replaced in subsequent runs, e.g. after a DB UX Design System update) in the file .github/copilot-instructions.md (if this file does not yet exist in your codebase, it will be created).

Note: The tool works with all package managers (npm, yarn, pnpm) and correctly handles symlinked packages in pnpm's node_modules structure.

Advanced Usage

You can also change the root path where the tool should check for node_modules:

npx @db-ux/agent-cli packages/frontend

This is useful in monorepo setups where your DB UX packages might be installed in a specific workspace directory.

What the tool does

  1. Scans your project's node_modules for installed @db-ux packages
  2. Extracts relevant documentation based on your installed versions
  3. Creates or updates .github/copilot-instructions.md with component documentation
  4. Provides AI agents with context about available components and their usage patterns

Best practices

We've had the best experience with GitHub Copilot and Amazon Q when using the following settings:

  • Agent mode works best for code generation and may also offer the best developer experience.
  • Regarding the provided models, GPT-4o seemed to strike the best balance between "used tokens" and performance, although "Claude Sonnet 4" is still better. However, you run out of tokens quite quickly with this model.
  • If you're primarily interested in testing this functionality at the moment, we have quite a bit of experience using a prompt that is both equal and non-trivial, but rather complex, such as "Can you create a new page with a dashboard? It should contain selections for KPIs. Each KPI is a card containing information and buttons."

Deutsche Bahn brand

As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and trademarks are bound of clear guidelines and restrictions even if being used with the code that we're providing with this product; Deutsche Bahn fully reserves all rights regarding the Deutsche Bahn brand, even though that we're providing the code of DB UX Design System products free to use and release it under the Apache 2.0 license. Please have a look at our brand portal at https://marketingportal.extranet.deutschebahn.com/ for any further questions and whom to contact on any brand issues.

For any usage outside of Deutsche Bahn websites and applications you aren't allowed to use any Deutsche Bahn brand and design assets as well as protected characteristics and trademarks, that for not including the DB Theme.

Contributions

Contributions are very welcome, please refer to the contribution guide.

Code of conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone – have a look at our Contributor Covenant Code of Conduct.

License

This project is licensed under Apache-2.0.