# AI use cases for Vibex (Raja0sama/vibex)

Repo: [Raja0sama/vibex](https://github.com/Raja0sama/vibex) | Use cases: 5 | Page: https://dedupedai.com/use-cases/raja0sama-vibex/

vibeX is a tool that generates architecture diagrams and checkable docs from your Prisma schema, OpenAPI document, GraphQL SDL, or source code, delivered as one standalone HTML file.

This file holds every use case of this repo. Each one starts with a "## " heading and ends with its URL.

- Draw the real data model from a Prisma schema: https://dedupedai.com/use-cases/raja0sama-vibex/draw-data-model-from-prisma-schema/
- Map every API endpoint from an OpenAPI document: https://dedupedai.com/use-cases/raja0sama-vibex/map-api-endpoints-from-openapi/
- Document a service and fail CI when the docs drift: https://dedupedai.com/use-cases/raja0sama-vibex/document-service-and-fail-ci-on-drift/
- Check which services call which, and catch broken links: https://dedupedai.com/use-cases/raja0sama-vibex/check-service-to-service-calls/
- Look at a vibeX demo before installing anything: https://dedupedai.com/use-cases/raja0sama-vibex/try-vibex-demo-without-installing/

## How to draw the real data model from a Prisma schema with Vibex

Repo: [Raja0sama/vibex](https://github.com/Raja0sama/vibex) | Difficulty: Intermediate | Time: 15 minutes | Basis: From the README

Turn a Prisma schema into a validated ERD that shows the tables that actually ship.

**Who it is for:** A developer joining a project or reviewing a database change who needs an accurate map of tables and relations.

**The problem:** Existing diagrams in wikis or whiteboards go stale, and nobody is sure which tables join which.

**The outcome:** A validated ERD spec and a standalone HTML viewer showing tables, PK/FK badges, and cardinality taken from the schema.

### Steps

1. `vibex import prisma  prisma/schema.prisma  docs/db.erd.json`
2. `vibex validate docs/db.erd.json`
3. `vibex render docs/db.erd.json --open`

### Prompt to paste into your agent

```text
In the repo <repo path>, import prisma/schema.prisma into docs/db.erd.json with vibeX, validate it, and render docs/db.erd.html. Report the table count and any validation errors. Verify that every foreign key in the schema appears as a relation in the ERD.
```

### Caveat

The ERD is generated from the Prisma schema, so it reflects what the schema declares, not what the database holds at runtime.

Disclaimer: Third-party repos we don't own or vouch for. AI-generated use cases can be wrong: review everything and run at your own risk. Full text: https://dedupedai.com/disclaimer/

URL: https://dedupedai.com/use-cases/raja0sama-vibex/draw-data-model-from-prisma-schema/

## How to map every API endpoint from an OpenAPI document with Vibex

Repo: [Raja0sama/vibex](https://github.com/Raja0sama/vibex) | Difficulty: Intermediate | Time: 15 minutes | Basis: From the README

Generate an endpoints diagram grouped by resource, with methods, auth, and status codes.

**Who it is for:** A backend or frontend developer who needs a quick reference to the REST routes or GraphQL operations in a service.

**The problem:** API docs are scattered or out of date, and reading a long OpenAPI file to find routes is slow.

**The outcome:** An endpoints spec and HTML viewer grouped by resource with method badges, auth, params, and response codes.

### Steps

1. `vibex import openapi openapi.yaml docs/api.endpoints.json` (inferred, check the README)
2. `vibex render docs/api.endpoints.json --open` (inferred, check the README)

### Prompt to paste into your agent

```text
In the repo <repo path>, import the OpenAPI file at <openapi file> into docs/api.endpoints.json with vibeX and render docs/api.endpoints.html. Report the number of endpoints per resource. Verify that the count matches the number of paths and methods in the OpenAPI document.
```

### Caveat

The README notes YAML OpenAPI needs npm install inside the skill folder when vibeX is installed by skills add or the plugin.

Disclaimer: Third-party repos we don't own or vouch for. AI-generated use cases can be wrong: review everything and run at your own risk. Full text: https://dedupedai.com/disclaimer/

URL: https://dedupedai.com/use-cases/raja0sama-vibex/map-api-endpoints-from-openapi/

## How to document a service and fail CI when the docs drift with Vibex

Repo: [Raja0sama/vibex](https://github.com/Raja0sama/vibex) | Difficulty: Advanced | Time: 60 minutes | Basis: From the README

Write checkable docs whose claims are anchored to code and re-verified on every build.

**Who it is for:** A tech lead who wants service documentation that stays accurate without someone rewriting it by hand.

**The problem:** Prose docs go stale silently, so readers cannot tell which statements still match the code.

**The outcome:** A docs spec with claims that show a confidence state, and a CI step that exits with an error when a claim no longer holds.

### Steps

1. `vibex docs system.docs.json specs/ --repo . --check`
2. `vibex dashboard docs/index.html docs --title "Payments platform" --repo .`

### Prompt to paste into your agent

```text
In the repo <repo path>, write a claims-based document for the <service name> service in system.docs.json, run vibeX docs with --check, and report how many claims are verified. Verify that the check exits with code 1 when you change an anchored line in a test copy.
```

### Caveat

vibeX catches drift after the claims are written, so a misreading in the first draft stays verified until a person reviews it.

Disclaimer: Third-party repos we don't own or vouch for. AI-generated use cases can be wrong: review everything and run at your own risk. Full text: https://dedupedai.com/disclaimer/

URL: https://dedupedai.com/use-cases/raja0sama-vibex/document-service-and-fail-ci-on-drift/

## How to check which services call which, and catch broken links with Vibex

Repo: [Raja0sama/vibex](https://github.com/Raja0sama/vibex) | Difficulty: Advanced | Time: 60 minutes | Basis: From the README

Record each cross-service call once and fail when a client, handler, or endpoint moves.

**Who it is for:** A platform engineer working across several repositories who needs a System view of service-to-service calls.

**The problem:** Nobody knows which service calls which, and renamed or removed endpoints break calls silently.

**The outcome:** A System view diagram and a check that lists broken calls and endpoints that nothing calls.

### Steps

1. `vibex links system.links.json docs --repo bff=../bff --repo orders=../orders --check`

### Prompt to paste into your agent

```text
Using the repos at <repo paths>, write system.links.json describing the calls between services, then run vibeX links with --check. Report any broken client, handler, or endpoint, and list endpoints nothing calls. Verify the check fails when a handler is renamed in a test copy.
```

### Caveat

The check reads the code it is pointed at, so repositories not passed with --repo cannot be verified.

Disclaimer: Third-party repos we don't own or vouch for. AI-generated use cases can be wrong: review everything and run at your own risk. Full text: https://dedupedai.com/disclaimer/

URL: https://dedupedai.com/use-cases/raja0sama-vibex/check-service-to-service-calls/

## How to look at a vibeX demo before installing anything with Vibex

Repo: [Raja0sama/vibex](https://github.com/Raja0sama/vibex) | Difficulty: Beginner | Time: 15 minutes | Basis: From the README

Run the demo command to see sample diagrams without installing the tool.

**Who it is for:** A developer or team lead who wants to see what vibeX outputs before adding it to a project.

**The problem:** It is hard to judge a documentation tool from a description alone.

**The outcome:** A folder of sample diagrams and documents to open in a browser.

### Steps

1. `npx @vibex/vibex demo out`
2. Open the generated HTML files in the out folder in a browser.

### Prompt to paste into your agent

```text
Run npx @vibex/vibex demo out in an empty directory and list the files created in out. Verify that at least one HTML file opens from disk without a server.
```

### Caveat

The demo shows sample output, so it does not reflect your own schema until you run an import on it.

Disclaimer: Third-party repos we don't own or vouch for. AI-generated use cases can be wrong: review everything and run at your own risk. Full text: https://dedupedai.com/disclaimer/

URL: https://dedupedai.com/use-cases/raja0sama-vibex/try-vibex-demo-without-installing/
