@docyrus/docyrus 0.0.15 → 0.0.17
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 +25 -2
- package/main.js +1028 -540
- package/main.js.map +4 -4
- package/package.json +2 -1
- package/resources/pi-agent/prompts/agent-system.md +25 -0
- package/resources/pi-agent/prompts/coder-append-system.md +19 -0
- package/resources/pi-agent/skills/docyrus-ai/SKILL.md +28 -0
- package/resources/pi-agent/skills/docyrus-api-dev/SKILL.md +161 -0
- package/resources/pi-agent/skills/docyrus-api-dev/references/api-client.md +349 -0
- package/resources/pi-agent/skills/docyrus-api-dev/references/authentication.md +238 -0
- package/resources/pi-agent/skills/docyrus-api-dev/references/data-source-query-guide.md +2059 -0
- package/resources/pi-agent/skills/docyrus-api-dev/references/formula-design-guide-llm.md +320 -0
- package/resources/pi-agent/skills/docyrus-api-dev/references/query-and-formulas.md +592 -0
- package/resources/pi-agent/skills/docyrus-api-doctor/SKILL.md +70 -0
- package/resources/pi-agent/skills/docyrus-api-doctor/references/checklist-details.md +588 -0
- package/resources/pi-agent/skills/docyrus-app-dev/SKILL.md +159 -0
- package/resources/pi-agent/skills/docyrus-app-dev/references/api-client-and-auth.md +275 -0
- package/resources/pi-agent/skills/docyrus-app-dev/references/collections-and-patterns.md +352 -0
- package/resources/pi-agent/skills/docyrus-app-dev/references/data-source-query-guide.md +2059 -0
- package/resources/pi-agent/skills/docyrus-app-dev/references/formula-design-guide-llm.md +320 -0
- package/resources/pi-agent/skills/docyrus-app-dev/references/query-guide.md +525 -0
- package/resources/pi-agent/skills/docyrus-app-ui-design/SKILL.md +466 -0
- package/resources/pi-agent/skills/docyrus-app-ui-design/references/component-selection-guide.md +602 -0
- package/resources/pi-agent/skills/docyrus-app-ui-design/references/icon-usage-guide.md +463 -0
- package/resources/pi-agent/skills/docyrus-app-ui-design/references/preferred-components-catalog.md +242 -0
- package/resources/pi-agent/skills/docyrus-apps/SKILL.md +54 -0
- package/resources/pi-agent/skills/docyrus-architect/SKILL.md +174 -0
- package/resources/pi-agent/skills/docyrus-architect/references/custom-query-guide.md +410 -0
- package/resources/pi-agent/skills/docyrus-architect/references/data-source-query-guide.md +2059 -0
- package/resources/pi-agent/skills/docyrus-architect/references/formula-design-guide-llm.md +320 -0
- package/resources/pi-agent/skills/docyrus-architect/references/formula-reference.md +145 -0
- package/resources/pi-agent/skills/docyrus-auth/SKILL.md +100 -0
- package/resources/pi-agent/skills/docyrus-cli-app/SKILL.md +279 -0
- package/resources/pi-agent/skills/docyrus-cli-app/references/cli-manifest.md +532 -0
- package/resources/pi-agent/skills/docyrus-cli-app/references/list-query-examples.md +248 -0
- package/resources/pi-agent/skills/docyrus-curl/SKILL.md +32 -0
- package/resources/pi-agent/skills/docyrus-discover/SKILL.md +63 -0
- package/resources/pi-agent/skills/docyrus-ds/SKILL.md +95 -0
- package/resources/pi-agent/skills/docyrus-env/SKILL.md +21 -0
- package/resources/pi-agent/skills/docyrus-studio/SKILL.md +369 -0
- package/resources/pi-agent/skills/docyrus-tui/SKILL.md +15 -0
package/resources/pi-agent/skills/docyrus-app-ui-design/references/preferred-components-catalog.md
ADDED
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
# Preferred Components Catalog
|
|
2
|
+
|
|
3
|
+
Complete reference of all 158 available components across shadcn, diceui, animate-ui, docyrus, and reui libraries.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
1. [shadcn Components (43)](#shadcn-components-43)
|
|
8
|
+
2. [diceui Components (41)](#diceui-components-41)
|
|
9
|
+
3. [animate-ui Components (21)](#animate-ui-components-21)
|
|
10
|
+
4. [docyrus Components (51)](#docyrus-components-51)
|
|
11
|
+
5. [reui Components (2)](#reui-components-2)
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## shadcn Components (43)
|
|
16
|
+
|
|
17
|
+
Core UI components for building accessible, well-designed interfaces.
|
|
18
|
+
|
|
19
|
+
| Component | Description | Install Command | Docs |
|
|
20
|
+
|-----------|-------------|-----------------|------|
|
|
21
|
+
| Accordion | A vertically stacked set of interactive headings that each reveal a section of content. | `pnpm dlx shadcn@latest add accordion` | docs/components/shadcn-accordion.md |
|
|
22
|
+
| Alert | Displays a callout for user attention. | `pnpm dlx shadcn@latest add alert` | docs/components/shadcn-alert.md |
|
|
23
|
+
| Aspect Ratio | Displays content within a desired ratio. | `pnpm dlx shadcn@latest add aspect-ratio` | docs/components/shadcn-aspect-ratio.md |
|
|
24
|
+
| Avatar | An image element with a fallback for representing the user. | `pnpm dlx shadcn@latest add avatar` | docs/components/shadcn-avatar.md |
|
|
25
|
+
| Badge | Displays a badge or a component that looks like a badge. | `pnpm dlx shadcn@latest add badge` | docs/components/shadcn-badge.md |
|
|
26
|
+
| Breadcrumb | Displays the path to the current resource using a hierarchy of links. | `pnpm dlx shadcn@latest add breadcrumb` | docs/components/shadcn-breadcrumb.md |
|
|
27
|
+
| Button | Displays a button or a component that looks like a button. | `pnpm dlx shadcn@latest add button` | docs/components/shadcn-button.md |
|
|
28
|
+
| Button Group | A container that groups related buttons together with consistent styling. | `pnpm dlx shadcn@latest add button-group` | docs/components/shadcn-button-group.md |
|
|
29
|
+
| Calendar | A calendar component that allows users to select a date or a range of dates. | `pnpm dlx shadcn@latest add calendar` | docs/components/shadcn-calendar.md |
|
|
30
|
+
| Card | Displays a card with header, content, and footer. | `pnpm dlx shadcn@latest add card` | docs/components/shadcn-card.md |
|
|
31
|
+
| Carousel | Displays multiple items in a scrollable container with motion and swipe gestures, commonly used for product galleries or image showcases. | `pnpm dlx shadcn@latest add carousel` | docs/components/shadcn-carousel.md |
|
|
32
|
+
| Chart | A collection of ready-to-use chart components built using Recharts that turn raw data into visual insights. | `pnpm dlx shadcn@latest add chart` | docs/components/shadcn-chart.md |
|
|
33
|
+
| Collapsible | An interactive component that expands and collapses a panel of content, often used to organize information like FAQs or advanced settings. | `pnpm dlx shadcn@latest add collapsible` | docs/components/shadcn-collapsible.md |
|
|
34
|
+
| Command | A React command palette component for fast search and execution of actions using keyboard shortcuts. | `pnpm dlx shadcn@latest add command` | docs/components/shadcn-command.md |
|
|
35
|
+
| Context Menu | Displays a menu of actions or functions, typically triggered by a right-click or long-press. | `pnpm dlx shadcn@latest add context-menu` | docs/components/shadcn-context-menu.md |
|
|
36
|
+
| Date Picker | A date picker component with range and presets. | `pnpm dlx shadcn@latest add popover calendar` | — |
|
|
37
|
+
| Direction | A provider component that sets the text direction for your application. | `pnpm dlx shadcn@latest add direction` | docs/components/shadcn-direction.md |
|
|
38
|
+
| Drawer | A sliding panel that appears from the side or bottom of the screen, commonly used for navigation menus, settings, or additional content, especially on mobile. | `pnpm dlx shadcn@latest add drawer` | docs/components/shadcn-drawer.md |
|
|
39
|
+
| Empty | Used to display an empty state when there is no content or data to show, providing context and guiding user action. | `pnpm dlx shadcn@latest add empty` | docs/components/shadcn-empty.md |
|
|
40
|
+
| Field | Field components combine labels, inputs, error messages, and helper text into complete form field units. | `pnpm dlx shadcn@latest add field` | docs/components/shadcn-field.md |
|
|
41
|
+
| Input | Displays a form input field or a component that looks like an input field. | `pnpm dlx shadcn@latest add input` | docs/components/shadcn-input.md |
|
|
42
|
+
| Input Group | Display additional information or actions to an input or textarea. | `pnpm dlx shadcn@latest add input-group` | docs/components/shadcn-input-group.md |
|
|
43
|
+
| Input OTP | Accessible component designed to collect one-time password codes with individual input fields for each digit. | `pnpm dlx shadcn@latest add input-otp` | docs/components/shadcn-input-otp.md |
|
|
44
|
+
| Item | A versatile component for displaying content with media, title, description, and actions, often used in lists. | `pnpm dlx shadcn@latest add item` | docs/components/shadcn-item.md |
|
|
45
|
+
| Kbd | Display a keyboard key or group of keys. | `pnpm dlx shadcn@latest add kbd` | docs/components/shadcn-kbd.md |
|
|
46
|
+
| Label | Renders an accessible label associated with controls. | `pnpm dlx shadcn@latest add label` | docs/components/shadcn-label.md |
|
|
47
|
+
| Menubar | A visually persistent menu common in desktop applications that provides quick access to a consistent set of commands. | `pnpm dlx shadcn@latest add menubar` | docs/components/shadcn-menubar.md |
|
|
48
|
+
| Native Select | A styled native HTML select element with consistent design system integration. | `pnpm dlx shadcn@latest add native-select` | docs/components/shadcn-native-select.md |
|
|
49
|
+
| Navigation Menu | A React component for website navigation with dropdowns, mega menus, and organized content sections. | `pnpm dlx shadcn@latest add navigation-menu` | docs/components/shadcn-navigation-menu.md |
|
|
50
|
+
| Pagination | Pagination provides next/previous buttons and page numbers to navigate through long lists or tables. | `pnpm dlx shadcn@latest add pagination` | docs/components/shadcn-pagination.md |
|
|
51
|
+
| Progress | Displays an indicator showing the completion progress of a task, typically displayed as a progress bar. | `pnpm dlx shadcn@latest add progress` | docs/components/shadcn-progress.md |
|
|
52
|
+
| Resizable | Accessible resizable panel groups and layouts with keyboard support for creating dynamic split views, editors, and dashboards. | `pnpm dlx shadcn@latest add resizable` | docs/components/shadcn-resizable.md |
|
|
53
|
+
| Scroll Area | Augments native scroll functionality for custom, cross-browser styling | `pnpm dlx shadcn@latest add scroll-area` | docs/components/shadcn-scroll-area.md |
|
|
54
|
+
| Select | Displays a list of options for the user to pick from—triggered by a button. | `pnpm dlx shadcn@latest add select` | docs/components/shadcn-select.md |
|
|
55
|
+
| Separator | Visually or semantically separates content. | `pnpm dlx shadcn@latest add separator` | docs/components/shadcn-separator.md |
|
|
56
|
+
| Subtopic | The short description for the 'shadcn Subtopic' component is not available in the provided context. | `pnpm dlx shadcn@latest add subtopic` | — |
|
|
57
|
+
| Skeleton | Displays a placeholder while content is loading. | `pnpm dlx shadcn@latest add skeleton` | docs/components/shadcn-skeleton.md |
|
|
58
|
+
| Slider | Input where the user selects a value from within a given range. | `pnpm dlx shadcn@latest add slider` | docs/components/shadcn-slider.md |
|
|
59
|
+
| Sonner | Displays modern, opinionated, non-intrusive toast notifications for feedback. | `pnpm dlx shadcn@latest add sonner` | docs/components/shadcn-sonner.md |
|
|
60
|
+
| Spinner | An indicator that can be used to show a loading state. | `pnpm dlx shadcn@latest add spinner` | docs/components/shadcn-spinner.md |
|
|
61
|
+
| Table | A responsive component used for displaying simple, structured data like invoices or feature comparisons. | `pnpm dlx shadcn@latest add table` | docs/components/shadcn-table.md |
|
|
62
|
+
| Textarea | Handles multi-line text input, ideal for messages, descriptions, or comments. | `pnpm dlx shadcn@latest add textarea` | docs/components/shadcn-textarea.md |
|
|
63
|
+
| Typography | Styles for headings, paragraphs, lists, and captions. | `pnpm dlx shadcn@latest add typography` | docs/components/shadcn-typography.md |
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## diceui Components (41)
|
|
68
|
+
|
|
69
|
+
Advanced, specialized components for complex UI patterns.
|
|
70
|
+
|
|
71
|
+
| Component | Description | Install Command | Docs |
|
|
72
|
+
|-----------|-------------|-----------------|------|
|
|
73
|
+
| Action Bar | A floating action bar that appears at the bottom or top of the viewport to display contextual actions for selected items. | `pnpm dlx shadcn@latest add "@diceui/action-bar"` | docs/components/action-bar.mdx |
|
|
74
|
+
| Badge Overflow | Displays a list of badges in confined space, using an overflow badge to show a count of hidden badges. | `pnpm dlx shadcn@latest add @diceui/badge-overflow` | docs/components/badge-overflow.mdx |
|
|
75
|
+
| Checkbox Group | A list of options where one or more choices can be selected. | `pnpm dlx shadcn@latest add @diceui/checkbox-group` | docs/components/checkbox-group.mdx |
|
|
76
|
+
| Circular Progress | A widget that shows progress along a circle. | `pnpm dlx shadcn@latest add @diceui/circular-progress` | docs/components/circular-progress.mdx |
|
|
77
|
+
| Color Picker | A compact component providing a wide color spectrum and predefined palette for precise color selection. | `pnpm add @diceui/color-picker` | docs/components/color-picker.mdx |
|
|
78
|
+
| Color Swatch | A color swatch component that displays a color value with optional transparency support. | `pnpm dlx shadcn@latest add "https://diceui.com/r/color-swatch"` | docs/components/color-swatch.mdx |
|
|
79
|
+
| Combobox | A combobox component combines an input field and a dropdown list, allowing users to search, filter, and select from a predefined set of choices. | `pnpm dlx shadcn@latest add @diceui/combobox` | docs/components/combobox.mdx |
|
|
80
|
+
| Compare Slider | Used to compare two images or components side-by-side with a draggable divider. | `pnpm dlx shadcn@latest add "https://diceui.com/r/compare-slider"` | docs/components/compare-slider.mdx |
|
|
81
|
+
| Data Grid | A high-performance editable data grid component with virtualization, keyboard navigation, and comprehensive cell editing capabilities. | `pnpm dlx shadcn@latest add "@diceui/data-table"` | docs/components/data-grid.mdx |
|
|
82
|
+
| Data Table | A powerful and flexible data table component for displaying, filtering, sorting, and paginating tabular data. | `pnpm dlx shadcn@latest add "@diceui/data-table"` | docs/components/data-table.mdx |
|
|
83
|
+
| Editable | An accessible inline editable component for editing text content in place. | `pnpm dlx shadcn@latest add "@diceui/editable"` | docs/components/editable.mdx |
|
|
84
|
+
| File Upload | A comprehensive file upload component built on top of shadcn-ui with drag-and-drop functionality, file preview, progress indicators, and multiple file support. | `pnpm dlx shadcn@latest add "https://diceui.com/r/file-upload"` | docs/components/file-upload.mdx |
|
|
85
|
+
| Gauge | A component that displays a single numeric value in a specified range, often using a dial or arc to show progress. | `pnpm dlx shadcn@latest add "@diceui/gauge"` | docs/components/gauge.mdx |
|
|
86
|
+
| Kanban | A drag and drop kanban board component for organizing items into columns. | `pnpm dlx shadcn@latest add @diceui/kanban` | docs/components/kanban.mdx |
|
|
87
|
+
| Key Value | A dynamic input component for managing key-value pairs with paste support and validation | `pnpm dlx shadcn@latest add @diceui/key-value` | docs/components/key-value.mdx |
|
|
88
|
+
| Listbox | Displays a list of selectable options for single or multiple selection. | `pnpm dlx shadcn@latest add @diceui/listbox` | docs/components/listbox.mdx |
|
|
89
|
+
| Mask Input | An input component that formats user input with predefined patterns. | `pnpm dlx shadcn@latest add @diceui/mask-input` | docs/components/mask-input.mdx |
|
|
90
|
+
| Masonry | A grid layout component that places elements in optimal position based on available vertical space. | `pnpm dlx shadcn@latest add "https://diceui.com/r/masonry"` | docs/components/masonry.mdx |
|
|
91
|
+
| Map Input | I do not have enough information to provide a short description for the "Map Input" component within the context provided. | `pnpm dlx shadcn@latest add "https://diceui.com/r/map-input"` | — |
|
|
92
|
+
| Media Player | Integrates a consistent and accessible video or audio playback experience. | `pnpm dlx shadcn@latest add "https://diceui.com/r/media-player"` | docs/components/media-player.mdx |
|
|
93
|
+
| Mention | Allows mentioning items in a list by a trigger character. | `pnpm dlx shadcn@latest add @diceui/mention` | docs/components/mention.mdx |
|
|
94
|
+
| Phone Input | An accessible phone input component with automatic country detection and international phone number formatting. | `pnpm dlx shadcn@latest add @diceui/phone-input` | docs/components/phone-input.mdx |
|
|
95
|
+
| QR Code | A flexible QR code component for generating and displaying QR codes with customization options. | `pnpm dlx shadcn@latest add "@diceui/qr-code"` | docs/components/qr-code.mdx |
|
|
96
|
+
| Rating | Enables users to apply a rating to an item or experience. | `pnpm dlx shadcn@latest add "https://diceui.com/r/rating"` | docs/components/rating.mdx |
|
|
97
|
+
| Relative Time Card | A hover card that displays relative time relative to local time with timezone information. | `pnpm dlx shadcn@latest add "https://diceui.com/r/relative-time-card"` | docs/components/relative-time-card.mdx |
|
|
98
|
+
| Responsive Dialog | A dialog component that automatically switches between a centered dialog on desktop and a bottom drawer on mobile. | `pnpm dlx shadcn@latest add @diceui/responsive-dialog` | docs/components/responsive-dialog.mdx |
|
|
99
|
+
| Scroll Spy | Dynamically highlights navigation links to indicate the current visible section in the viewport during page scroll. | `pnpm dlx shadcn@latest add @diceui/scroll-spy` | docs/components/scroll-spy.mdx |
|
|
100
|
+
| Scroller | A scrollable container with automatic navigation buttons that appear when content overflows. | `pnpm dlx shadcn@latest add @diceui/scroller` | docs/components/scroller.mdx |
|
|
101
|
+
| Segmented Input | A linear set of two or more segments, each of which functions as a button or toggle for related choices. | `pnpm dlx shadcn@latest add "https://diceui.com/r/segmented-input"` | docs/components/segmented-input.mdx |
|
|
102
|
+
| Selection Toolbar | I do not have a description for the "Selection Toolbar" component in the provided document. | `pnpm dlx shadcn@latest add "@diceui/action-bar"` | docs/components/action-bar.mdx |
|
|
103
|
+
| Sortable | A drag and drop sortable component for reordering items. | `pnpm dlx shadcn@latest add @diceui/sortable` | docs/components/sortable.mdx |
|
|
104
|
+
| Speed Dial | A floating action button that expands to reveal a set of related actions, providing quick access to frequently used functions in a compact interface. | `pnpm dlx shadcn@latest add "@diceui/speed-dial"` | docs/components/speed-dial.mdx |
|
|
105
|
+
| Stack | The main stack container that handles layout and masking of child elements. | `pnpm dlx shadcn@latest add "https://diceui.com/r/stack"` | docs/components/stack.mdx |
|
|
106
|
+
| Stat | Used to show numbers and data in a block. | `pnpm dlx shadcn@latest add "https://diceui.com/r/stat"` | docs/components/stat.mdx |
|
|
107
|
+
| Status | Displays a status indicator icon. | `pnpm dlx shadcn@latest add "https://diceui.com/r/status"` | docs/components/status.mdx |
|
|
108
|
+
| Stepper | A component that guides users through a multi-step process with clear visual progress indicators. | `pnpm dlx shadcn@latest add @diceui/stepper` | docs/components/stepper.mdx |
|
|
109
|
+
| Swap | A component that swaps between two states with click or hover activation modes. | `pnpm dlx shadcn@latest add "https://diceui.com/r/swap"` | docs/components/swap.mdx |
|
|
110
|
+
| Tags Input | A component that allows users to add tags to an input field. | `pnpm dlx shadcn@latest add @diceui/tags-input` | docs/components/tags-input.mdx |
|
|
111
|
+
| Time Picker | Allow users to select specific times for scheduling events or setting appointments. | `pnpm dlx shadcn@latest add "https://diceui.com/r/time-picker"` | docs/components/time-picker.mdx |
|
|
112
|
+
| Timeline | Timeline is a flexible family of components for displaying events, steps, or progress in a vertical or horizontal layout. | `pnpm dlx shadcn@latest add @diceui/timeline` | docs/components/timeline.mdx |
|
|
113
|
+
| Tour | Displays a multi-step component used for interactive tutorials or onboarding new features. | `pnpm dlx shadcn@latest add @diceui/tour` | docs/components/tour.mdx |
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## animate-ui Components (21)
|
|
118
|
+
|
|
119
|
+
Animated components with smooth transitions and interactions.
|
|
120
|
+
|
|
121
|
+
| Component | Description | Install Command | Docs |
|
|
122
|
+
|-----------|-------------|-----------------|------|
|
|
123
|
+
| Alert Dialog | A modal dialog that interrupts the user with important content and expects a response. | `pnpm dlx shadcn@latest add @animate-ui/alert-dialog` | docs/components/animate-ui/alert-dialog.md |
|
|
124
|
+
| Avatar Group | An animated avatar group that displays overlapping user images and smoothly shifts each avatar forward on hover to highlight it. | `pnpm dlx shadcn@latest add @animate-ui/avatar-group` | docs/components/animate-ui/avatar-group.md |
|
|
125
|
+
| Checkbox | A control that allows the user to toggle between checked and not checked. | `pnpm dlx shadcn@latest add @animate-ui/checkbox` | docs/components/animate-ui/checkbox.md |
|
|
126
|
+
| Dialog | A window overlaid on either the primary window or another dialog window, rendering the content underneath inert. | `pnpm dlx shadcn@latest add @animate-ui/dialog` | docs/components/animate-ui/dialog.md |
|
|
127
|
+
| Dropdown Menu | Displays a menu to the user — such as a set of actions or functions — triggered by a button. | `pnpm dlx shadcn@latest add @animate-ui/dropdown-menu` | docs/components/animate-ui/dropdown-menu.md |
|
|
128
|
+
| Files | A component that allows you to display a list of files and folders. | `pnpm dlx shadcn@latest add @animate-ui/file-tree` | docs/components/animate-ui/file-tree.md |
|
|
129
|
+
| Flip Card | A 3D animated card component that flips to reveal content on the back. | `pnpm dlx shadcn@latest add @animate-ui/flip-card` | docs/components/animate-ui/flip-card.md |
|
|
130
|
+
| Management Bar | A management bar that combines pagination, action buttons, and a call-to-action for streamlined item handling. | `pnpm dlx shadcn@latest add @animate-ui/floating-bar` | docs/components/animate-ui/floating-bar.md |
|
|
131
|
+
| Hover Card | For sighted users to preview content available behind a link. | `pnpm dlx shadcn@latest add @animate-ui/hover-card` | docs/components/animate-ui/hover-card.md |
|
|
132
|
+
| Pin List | A playful list for pinning and unpinning items, with smooth animated transitions as items move between groups. | `pnpm dlx shadcn@latest add @animate-ui/pin-list` | docs/components/animate-ui/pin-list.md |
|
|
133
|
+
| Popover | Displays rich content in a portal, triggered by a button. | `pnpm dlx shadcn@latest add @animate-ui/popover` | docs/components/animate-ui/popover.md |
|
|
134
|
+
| Preview Link Card | Displays a preview image of a link when hovered. | `pnpm dlx shadcn@latest add @animate-ui/preview-link` | docs/components/animate-ui/preview-link.md |
|
|
135
|
+
| Radial Menu | A circular context menu built with Base UI, displaying actions in a clean radial layout with full keyboard support and smooth interaction. | `pnpm dlx shadcn@latest add @animate-ui/radial-menu` | docs/components/animate-ui/radial-menu.md |
|
|
136
|
+
| Radio Group | A set of checkable buttons—known as radio buttons—where no more than one of the buttons can be checked at a time. | `pnpm dlx shadcn@latest add @animate-ui/radio-group` | docs/components/animate-ui/radio-group.md |
|
|
137
|
+
| Sheet | Extends the Dialog component to display content that complements the main content of the screen. | `pnpm dlx shadcn@latest add @animate-ui/sheet` | docs/components/animate-ui/sheet.md |
|
|
138
|
+
| Sidebar | A composable, themeable and customizable sidebar component. Created by Shadcn and animated by Animate UI. | `pnpm dlx shadcn@latest add @animate-ui/sidebar` | docs/components/animate-ui/sidebar.md |
|
|
139
|
+
| Switch | A control that allows the user to toggle between checked and not checked. | `pnpm dlx shadcn@latest add @animate-ui/switch` | docs/components/animate-ui/switch.md |
|
|
140
|
+
| Tabs | A set of layered sections of content—known as tab panels—that are displayed one at a time. | `pnpm dlx shadcn@latest add @animate-ui/tabs` | docs/components/animate-ui/tabs.md |
|
|
141
|
+
| Toggle Group | A set of two-state buttons that can be toggled on or off. | `pnpm dlx shadcn@latest add @animate-ui/toggle-group` | docs/components/animate-ui/toggle-group.md |
|
|
142
|
+
| Toggle | A two-state button that can be either on or off. | `pnpm dlx shadcn@latest add @animate-ui/toggle` | docs/components/animate-ui/toggle.md |
|
|
143
|
+
| Tooltip | A popup that displays information related to an element when the element receives keyboard focus or the mouse hovers over it. | `pnpm dlx shadcn@latest add @animate-ui/tooltip` | docs/components/animate-ui/tooltip.md |
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## docyrus Components (51)
|
|
148
|
+
|
|
149
|
+
Docyrus-specific components for data handling, forms, dialogs, editing, scheduling, chat, AI agents, and business logic.
|
|
150
|
+
|
|
151
|
+
| Component | Description | Install Command | Docs |
|
|
152
|
+
|-----------|-------------|-----------------|------|
|
|
153
|
+
| Awesome Dialog | Advanced dialog system with three container modes (modal, sheet, drawer), side positioning, size presets, pattern backgrounds, fullscreen/minimize/resize support, and global dialog management via GlobalDialogProvider. The primary dialog system for item creation forms and small item detail views. | `pnpm dlx @docyrus/cli add @docyrus/ui-awesome-dialog` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/awesome-dialog/llms.txt) |
|
|
154
|
+
| Awesome Card | A card with a hatched-stripe header and an inset content area, perfect for displaying stats and metrics. | `pnpm dlx @docyrus/cli add @docyrus/ui-awesome-card` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/awesome-card/llms.txt) |
|
|
155
|
+
| Awesome Stats | Data-driven metric cards with grid, flex, and animated tabs layouts. Supports sparkline/bar/area mini-charts, comparison deltas, drag-and-drop reordering, Intl.NumberFormat value formatting, and AwesomeCard styling mode. | `pnpm dlx @docyrus/cli add @docyrus/ui-awesome-stats` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/awesome-stats/llms.txt) |
|
|
156
|
+
| Avatar Select | Avatar Select component with multiple variants and sizes. | `pnpm dlx @docyrus/cli add @docyrus/ui-avatar-select` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/avatar-select/llms.txt) |
|
|
157
|
+
| Avatar Thumbnail | Avatar Thumbnail component with multiple variants and sizes. | `pnpm dlx @docyrus/cli add @docyrus/ui-avatar-thumbnail` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/avatar-thumbnail/llms.txt) |
|
|
158
|
+
| Calendar | Advanced calendar with month/week/day/agenda views, drag-and-drop event management, multi-user support, and loading states. | `pnpm dlx @docyrus/cli add @docyrus/ui-calendar` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/calendar/llms.txt) |
|
|
159
|
+
| Comments Panel | Comment discussion panel with threaded conversations, mention input, and editor support. | `pnpm dlx @docyrus/cli add @docyrus/ui-comments-panel` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/comments-panel/llms.txt) |
|
|
160
|
+
| Confirmation Button | Button with built-in confirmation dialog for destructive or important actions. | `pnpm dlx @docyrus/cli add @docyrus/ui-confirmation-button` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/confirmation-button/llms.txt) |
|
|
161
|
+
| Contact Activity Panel | Contact-centric activity timeline showing calls, meetings, emails, tasks, chats, and record changes. Supports threaded replies, emoji reactions, file attachments, @mentions, and entity linking. Filter by activity type with animated transitions. | `pnpm dlx @docyrus/cli add @docyrus/ui-contact-activity-panel` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/contact-activity-panel/llms.txt) |
|
|
162
|
+
| Create Record Dialog | Quick-create popover dialog for new records with subject/description inputs, inline mention triggers, selector fields (header and footer), AI actions, footer toggles, and create-more support. Designed for fast item creation without a full form. | `pnpm dlx @docyrus/cli add @docyrus/ui-create-record-dialog` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/create-record-dialog/llms.txt) |
|
|
163
|
+
| Data Grid | A virtualized, editable spreadsheet-like data grid with sorting, filtering, grouping, cell selection, and keyboard navigation. Supports grid/gallery/card display modes. | `pnpm dlx @docyrus/cli add @docyrus/ui-data-grid` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/data-grid/llms.txt) |
|
|
164
|
+
| Data Grid View Select | View selector companion for Data Grid. Supports dropdown, horizontal-tabs, and vertical-tabs variants. Manages saved views with sort, filter (query builder), column visibility, grouping, and view CRUD operations. | `pnpm dlx @docyrus/cli add @docyrus/ui-data-grid-view-select` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/data-grid-view-select/llms.txt) |
|
|
165
|
+
| Data Table Filter | A composable filter bar for data tables with text, number, date, option, and multi-option column types. | `pnpm dlx @docyrus/cli add @docyrus/ui-data-table-filter` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/data-table-filter/llms.txt) |
|
|
166
|
+
| Date Time Picker | Date Time Picker component with multiple variants and sizes. | `pnpm dlx @docyrus/cli add @docyrus/ui-date-time-picker` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/date-time-picker/llms.txt) |
|
|
167
|
+
| Date Time Range Picker | Select start and end date/time pairs with sm/default/lg size variants. Integrates with react-hook-form. | `pnpm dlx @docyrus/cli add @docyrus/ui-date-time-range-picker` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/date-time-range-picker/llms.txt) |
|
|
168
|
+
| Day Picker | Day Picker component with multiple variants and sizes. | `pnpm dlx @docyrus/cli add @docyrus/ui-day-picker` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/day-picker/llms.txt) |
|
|
169
|
+
| Delete Confirm Dialog | Delete Confirm Dialog component with multiple variants and sizes. | `pnpm dlx @docyrus/cli add @docyrus/ui-delete-confirm-dialog` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/delete-confirm-dialog/llms.txt) |
|
|
170
|
+
| Docyrus Agent | AI agent interface with three modes: chat (conversational), action-panel (parameter-based actions), and trigger (floating button that opens dialog). Supports Vercel AI SDK messages, file attachments, action execution with typed params, agent profiles, and source documents. | `pnpm dlx @docyrus/cli add @docyrus/ui-docyrus-agent` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/docyrus-agent/llms.txt) |
|
|
171
|
+
| Docyrus Icon | Docyrus Icon component with multiple variants and sizes. | `pnpm dlx @docyrus/cli add @docyrus/ui-docyrus-icon` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/docyrus-icon/llms.txt) |
|
|
172
|
+
| Duration Select | Duration Select component with multiple variants and sizes. | `pnpm dlx @docyrus/cli add @docyrus/ui-duration-select` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/duration-select/llms.txt) |
|
|
173
|
+
| Editable Record Detail | Complete inline record editor with field-level change tracking, floating ActionBar showing pending changes, save/cancel with diff preview, and TanStack Form compatible API. Use for detail views where users edit individual fields without opening a full form. | `pnpm dlx @docyrus/cli add @docyrus/ui-editable-record-detail` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/editable-record-detail/llms.txt) |
|
|
174
|
+
| Editable Value | Single-field inline editor that renders DynamicValue in display mode and switches to DynamicFormField on click. Supports inline, popover, and instant-save field types with automatic save/cancel behavior. | `pnpm dlx @docyrus/cli add @docyrus/ui-editable-value` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/editable-value/llms.txt) |
|
|
175
|
+
| Email Composer | Email composition component with To/Cc/Bcc recipient fields (chip-based input with validation), subject line, rich-text body with formatting toolbar (bold, italic, underline, strikethrough, links, lists), file attachments display, and send/discard actions. Supports default/outline/minimal variants and sm/default/lg sizes. | `pnpm dlx @docyrus/cli add @docyrus/ui-email-composer` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/email-composer/llms.txt) |
|
|
176
|
+
| File Attachment Panel | File management panel with upload zone, file list/grid views, and empty state handling. | `pnpm dlx @docyrus/cli add @docyrus/ui-file-attachment-panel` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/file-attachment-panel/llms.txt) |
|
|
177
|
+
| Form Fields | Dynamic form field system powered by TanStack Form. 47 field types with automatic dispatch via DynamicFormField. | `pnpm dlx @docyrus/cli add @docyrus/ui-form-fields` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/form-fields/llms.txt) |
|
|
178
|
+
| Gantt | Gantt chart visualization for project timelines, task dependencies, and scheduling. | `pnpm dlx @docyrus/cli add @docyrus/ui-gantt` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/gantt/llms.txt) |
|
|
179
|
+
| Image Editor | Advanced image editor with cropping, adjustments, and transformation tools. | `pnpm dlx @docyrus/cli add @docyrus/ui-image-editor` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/image-editor/llms.txt) |
|
|
180
|
+
| Kanban | Drag-and-drop kanban board with sortable columns and cards. Built on dnd-kit with keyboard navigation, multi-container support, collision detection, and drag overlay. Compound components: Kanban, KanbanBoard, KanbanColumn, KanbanCard, KanbanCardHandle, KanbanOverlay. | `pnpm dlx @docyrus/cli add @docyrus/ui-kanban` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/kanban/llms.txt) |
|
|
181
|
+
| Log Activity Form | Capture activities (calls, emails, meetings, tasks, status updates, comments) with rich Plate editor, mention users, calendar event linking, status tracking, and follow-up dates. Specialized sections for each activity type. | `pnpm dlx @docyrus/cli add @docyrus/ui-log-activity-form` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/log-activity-form/llms.txt) |
|
|
182
|
+
| Map | Map visualization component built on Leaflet for displaying geographic data and locations. | `pnpm dlx @docyrus/cli add @docyrus/ui-map` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/map/llms.txt) |
|
|
183
|
+
| Mega Select | Large grid-based item selector with category tabs, search, detail panel, and keyboard navigation. Supports thin/default/large/full sizes and default/elevated/flat variants. Ideal for template pickers, product catalogs, or any rich selection UI with icons, images, colors, and descriptions. | `pnpm dlx @docyrus/cli add @docyrus/ui-mega-select` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/mega-select/llms.txt) |
|
|
184
|
+
| Morph Popover | Morphing popover that smoothly transitions between trigger and content states. | `pnpm dlx @docyrus/cli add @docyrus/ui-morph-popover` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/morph-popover/llms.txt) |
|
|
185
|
+
| Notification Stack | Stacked notification cards with animation for displaying multiple notifications. | `pnpm dlx @docyrus/cli add @docyrus/ui-notification-stack` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/notification-stack/llms.txt) |
|
|
186
|
+
| Notifications Panel | Full notification panel for managing and displaying user notifications. | `pnpm dlx @docyrus/cli add @docyrus/ui-notifications-panel` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/notifications-panel/llms.txt) |
|
|
187
|
+
| Pivot Grid | Sophisticated pivot table with 3-level row/column hierarchies, subtotals, grand totals, drilldown to raw data, pinning, resizing, conditional cell coloring via JSONata, and export to CSV/Excel/PDF. Built on TanStack Table + TanStack Virtual. | `pnpm dlx @docyrus/cli add @docyrus/ui-pivot-grid` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/pivot-grid/llms.txt) |
|
|
188
|
+
| Place Autocomplete | Location autocomplete input with address search and selection. | `pnpm dlx @docyrus/cli add @docyrus/ui-place-autocomplete` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/place-autocomplete/llms.txt) |
|
|
189
|
+
| Pricing Engine Panel | Full pricing/quoting engine with editable line items table, product catalog integration, category hierarchy, per-line and global discounts, multi-VAT rate support, currency with secondary currency and exchange rates, net/gross view modes, totals/VAT summary, description and terms sections, and save/draft actions. Variants: default/bordered/compact. | `pnpm dlx @docyrus/cli add @docyrus/ui-pricing-engine-panel` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/pricing-engine-panel/llms.txt) |
|
|
190
|
+
| Query Builder | Visual query builder for constructing filter conditions with drag-and-drop, rule numbers, and depth control. | `pnpm dlx @docyrus/cli add @docyrus/ui-query-builder` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/query-builder/llms.txt) |
|
|
191
|
+
| Radio Group | Radio group with "default" (simple list) and "card" (selectable cards) variants. Options support icons, descriptions, and color accents. Grid layout with configurable column count (1-4). | `pnpm dlx @docyrus/cli add @docyrus/ui-radio-group` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/radio-group/llms.txt) |
|
|
192
|
+
| Record Activity Panel | Activity log panel for displaying record history and audit trail. | `pnpm dlx @docyrus/cli add @docyrus/ui-record-activity-panel` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/record-activity-panel/llms.txt) |
|
|
193
|
+
| Record Delete Confirm Dialog | Domain-specific delete confirmation with record context. | `pnpm dlx @docyrus/cli add @docyrus/ui-record-delete-confirm-dialog` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/record-delete-confirm-dialog/llms.txt) |
|
|
194
|
+
| Record Sharing | Record sharing panel with bitmask permission system (Read/Write/Comment/Share/Delete), permission presets (Can View/Comment/Edit/Share/Full Access), search for users/teams/roles/tenants, and per-entity permission management. Trigger variants: button or avatar-group. | `pnpm dlx @docyrus/cli add @docyrus/ui-record-sharing` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/record-sharing/llms.txt) |
|
|
195
|
+
| Resource Scheduler Panel | Horizontal timeline resource scheduler with configurable presets (hour/day/week/month/year), drag-and-drop event moving and resizing, resource list with custom TanStack Table columns, today indicator, event popovers, and event bar variants (solid/outlined/subtle). | `pnpm dlx @docyrus/cli add @docyrus/ui-resource-scheduler-panel` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/resource-scheduler-panel/llms.txt) |
|
|
196
|
+
| Schema Repeater | Dynamic list manager for structured data entries with customizable input types per column. Ideal for filter rule builders, key-value editors, and repeating field groups. | `pnpm dlx @docyrus/cli add @docyrus/ui-schema-repeater` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/schema-repeater/llms.txt) |
|
|
197
|
+
| Search Input | Dedicated search input component with search icon and clear button. | `pnpm dlx @docyrus/cli add @docyrus/ui-search-input` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/search-input/llms.txt) |
|
|
198
|
+
| Simple Markdown Editor | Lightweight markdown editor powered by overtype with configurable toolbar, auto-resize, word/character stats, spellcheck, and resizable handle. Variants: default/muted. Sizes: sm/default/lg. Exposes imperative ref for focus/blur/getValue/setValue. | `pnpm dlx @docyrus/cli add @docyrus/ui-simple-markdown-editor` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/simple-markdown-editor/llms.txt) |
|
|
199
|
+
| Stepper | Multi-step progress indicator with 6 visual variants (default, outline, dots, dashed, gradient, minimal), horizontal/vertical orientations, three sizes, non-linear navigation, alternative label positioning, custom icons, and animated connectors. | `pnpm dlx @docyrus/cli add @docyrus/ui-stepper` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/stepper/llms.txt) |
|
|
200
|
+
| Team Chat Channel | Full-featured team chat component with rich text posts (Plate editor), threaded replies, emoji reactions, file attachments, link previews, entity mentions (@-trigger linked to data sources), hashtags, post editing/deletion, and real-time-ready callbacks. | `pnpm dlx @docyrus/cli add @docyrus/ui-team-chat-channel` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/team-chat-channel/llms.txt) |
|
|
201
|
+
| Time Slot Scheduler | Appointment booking scheduler with columns view (multi-day time grid) and month calendar view. Manages slot capacity, reservations, unavailable ranges, timezone selection, weekend toggle, min/max date bounds, and slot popover with reservation details. Ideal for booking pages and availability scheduling. | `pnpm dlx @docyrus/cli add @docyrus/ui-time-slot-scheduler` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/time-slot-scheduler/llms.txt) |
|
|
202
|
+
| Tree View | Tree/hierarchy visualization component for displaying nested data structures. | `pnpm dlx @docyrus/cli add @docyrus/ui-tree-view` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/tree-view/llms.txt) |
|
|
203
|
+
| Value Renderers | Read-only value display system for table cells, detail views, and kanban cards. 44 renderer types with automatic dispatch via DynamicValue. | `pnpm dlx @docyrus/cli add @docyrus/ui-value-renderers` | [llms.txt](https://alpha-ui.docy.app/docs/web/components/value-renderers/llms.txt) |
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## reui Components (2)
|
|
208
|
+
|
|
209
|
+
Utility components for specialized file and sorting operations.
|
|
210
|
+
|
|
211
|
+
| Component | Description | Install Command | Docs |
|
|
212
|
+
|-----------|-------------|-----------------|------|
|
|
213
|
+
| File Upload | Allows users to transfer files from their devices to a web application. | `pnpm dlx shadcn@latest add @reui/file-upload-default` | docs/components/reui-file-upload.md |
|
|
214
|
+
| Sortable | Allows reordering of items within a list or grid using drag-and-drop functionality. | `pnpm dlx shadcn@latest add @reui/sortable` | docs/components/reui-sortable.md |
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
## Docyrus UI Guide Documentation
|
|
219
|
+
|
|
220
|
+
Fetch these llms.txt endpoints for detailed guidance on installation, theming, and patterns:
|
|
221
|
+
|
|
222
|
+
| Guide | Description | Docs |
|
|
223
|
+
|-------|-------------|------|
|
|
224
|
+
| Components Overview | Production-ready UI components built with React, TypeScript, Tailwind CSS v4, and CVA variants. | [llms.txt](https://alpha-ui.docy.app/docs/web/components/llms.txt) |
|
|
225
|
+
| Installation | How to install and set up Docyrus UI components in your project. | [llms.txt](https://alpha-ui.docy.app/docs/web/guide/installation/llms.txt) |
|
|
226
|
+
| Theming | Customize the look and feel of Docyrus UI components with CSS variables and the theme generator. | [llms.txt](https://alpha-ui.docy.app/docs/web/guide/theming/llms.txt) |
|
|
227
|
+
| Distributions | Component distributions and core libraries that power Docyrus UI web components. | [llms.txt](https://alpha-ui.docy.app/docs/web/guide/distributions/llms.txt) |
|
|
228
|
+
| Examples & Recipes | Practical multi-component patterns and recipes for common UI scenarios. | [llms.txt](https://alpha-ui.docy.app/docs/web/guide/examples/llms.txt) |
|
|
229
|
+
| Troubleshooting | Common issues and solutions when using Docyrus UI web components. | [llms.txt](https://alpha-ui.docy.app/docs/web/guide/troubleshooting/llms.txt) |
|
|
230
|
+
| Releases | Latest releases and updates for Docyrus UI web components. | [llms.txt](https://alpha-ui.docy.app/docs/web/guide/releases/llms.txt) |
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
## Component Count Summary
|
|
235
|
+
|
|
236
|
+
- **shadcn**: 43 components
|
|
237
|
+
- **diceui**: 41 components
|
|
238
|
+
- **animate-ui**: 21 components
|
|
239
|
+
- **docyrus**: 51 components
|
|
240
|
+
- **reui**: 2 components
|
|
241
|
+
|
|
242
|
+
**Total**: 158 components
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: docyrus-apps
|
|
3
|
+
description: App commands. Archive an app, List apps (/v1/apps), Permanently delete an app, Restore an archived app. Run `docyrus apps --help` for usage details.
|
|
4
|
+
command: docyrus apps
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# docyrus apps delete
|
|
8
|
+
|
|
9
|
+
Archive an app
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
| Flag | Type | Default | Description |
|
|
14
|
+
|------|------|---------|-------------|
|
|
15
|
+
| `--appId` | `string` | | App ID |
|
|
16
|
+
| `--appSlug` | `string` | | App slug |
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# docyrus apps list
|
|
21
|
+
|
|
22
|
+
List apps (/v1/apps)
|
|
23
|
+
|
|
24
|
+
## Options
|
|
25
|
+
|
|
26
|
+
| Flag | Type | Default | Description |
|
|
27
|
+
|------|------|---------|-------------|
|
|
28
|
+
| `--appType` | `string` | | Optional app type filter |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
# docyrus apps permanent-delete
|
|
33
|
+
|
|
34
|
+
Permanently delete an app
|
|
35
|
+
|
|
36
|
+
## Options
|
|
37
|
+
|
|
38
|
+
| Flag | Type | Default | Description |
|
|
39
|
+
|------|------|---------|-------------|
|
|
40
|
+
| `--appId` | `string` | | App ID |
|
|
41
|
+
| `--appSlug` | `string` | | App slug |
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
# docyrus apps restore
|
|
46
|
+
|
|
47
|
+
Restore an archived app
|
|
48
|
+
|
|
49
|
+
## Options
|
|
50
|
+
|
|
51
|
+
| Flag | Type | Default | Description |
|
|
52
|
+
|------|------|---------|-------------|
|
|
53
|
+
| `--appId` | `string` | | App ID |
|
|
54
|
+
| `--appSlug` | `string` | | App slug |
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: docyrus-architect
|
|
3
|
+
description: Use the Docyrus Architect MCP tools to manage data sources, fields, enums, apps, custom queries, and query data in the Docyrus platform. Use when the user asks to create, update, delete, or query data sources, fields, enum options, apps, or custom query templates via the docyrus-architect MCP server. Also use when building reports, dashboards, or performing data analysis that requires querying Docyrus data sources or running custom SQL templates with filters, aggregations, formulas, pivots, or child queries.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Docyrus Architect
|
|
7
|
+
|
|
8
|
+
Guide for using `docyrus-architect` MCP tools to manage and query data sources in Docyrus.
|
|
9
|
+
|
|
10
|
+
## Tool Overview
|
|
11
|
+
|
|
12
|
+
### Discovery Tools
|
|
13
|
+
- `get_apps` — List tenant apps. Use before `create_data_source` to find the target `tenantAppId`.
|
|
14
|
+
- `get_data_source_list` — Search data sources by name/description or app ID.
|
|
15
|
+
- `get_data_source_list_with_fields` — Same as above but includes field names and types.
|
|
16
|
+
- `get_data_source_metadata` — Get full metadata (fields with IDs, types, slugs, enums, relations) for a data source. **Always call this before querying** to discover field slugs and relation targets.
|
|
17
|
+
- `get_enums_by_field_id` — Get enum options for select/status/tagSelect fields.
|
|
18
|
+
- `read_current_user` / `read_tenant_user` — Get user info.
|
|
19
|
+
|
|
20
|
+
### Data Source CRUD
|
|
21
|
+
- `create_data_source` — Create a new data source (table). Default fields auto-created: `id`, `autonumber_id`, `name`, `record_owner`, `created_on`, `created_by`, `last_modified_by`, `last_modified_on`.
|
|
22
|
+
- `create_data_sources_batch` — Create multiple data sources with fields and enum options in a single atomic transaction. Supports cross-referencing data sources within the batch by slug for `field-relation` types. Max 20 data sources per batch.
|
|
23
|
+
- `update_data_source` — Update data source properties.
|
|
24
|
+
- `delete_data_source` — Delete a data source and all its data.
|
|
25
|
+
|
|
26
|
+
### Field Management
|
|
27
|
+
- `create_fields` — Batch create fields. Set `relationDataSourceId` for `field-relation` types.
|
|
28
|
+
- `update_fields` — Batch update fields. Non-CUSTOM fields get customization records.
|
|
29
|
+
- `delete_fields` — Batch delete fields by ID.
|
|
30
|
+
|
|
31
|
+
### Enum Management
|
|
32
|
+
- `create_enums` — Create enum options for select/tagSelect/status fields. Pass `fieldId` for field-specific enums or `enumSetId` for shared enum sets.
|
|
33
|
+
- `update_enums` — Update enum option name/slug/color/icon.
|
|
34
|
+
- `delete_enums` — Delete enum options.
|
|
35
|
+
|
|
36
|
+
### OpenAPI Spec
|
|
37
|
+
- `regenerate_openapi_spec` — Regenerate and upload the tenant's OpenAPI spec after data source or field changes. Accepts optional `dataSourceSlugs` (string array) to limit scope; omit to include all data sources. Returns the `publicUrl` of the uploaded spec. **Call this after any `create_data_source`, `update_data_source`, `delete_data_source`, `create_fields`, `update_fields`, or `delete_fields` operation** to keep the spec in sync.
|
|
38
|
+
|
|
39
|
+
### Query & Compute
|
|
40
|
+
- `query_data_source` — Read data with filtering, sorting, aggregation, formulas, pivots, child queries. **See [references/data-source-query-guide.md](references/data-source-query-guide.md) for complete query syntax.**
|
|
41
|
+
- `evaluate_jsonata` — Test JSONata expressions. Use for validating computed field formulas.
|
|
42
|
+
|
|
43
|
+
### Custom Queries
|
|
44
|
+
- `get_custom_queries` — List non-archived custom queries for the tenant.
|
|
45
|
+
- `get_custom_query_by_id` — Read full custom query definition (`name`, `description`, `query`, `filters`).
|
|
46
|
+
- `create_custom_query` — Create a saved SQL template using Handlebars variables and optional filter definitions.
|
|
47
|
+
- `update_custom_query` — Update selected fields of an existing custom query (partial update).
|
|
48
|
+
- `delete_custom_query` — Soft-delete (archive) a custom query.
|
|
49
|
+
- `run_custom_query` — Execute a saved custom query with runtime filters, pagination offset, and optional simulate mode.
|
|
50
|
+
|
|
51
|
+
## Common Workflows
|
|
52
|
+
|
|
53
|
+
### Create a Data Source with Fields and Enums
|
|
54
|
+
|
|
55
|
+
**Single data source approach:**
|
|
56
|
+
1. Call `get_apps` to find the target app ID
|
|
57
|
+
2. Call `create_data_source` with title (plural), name (singular), slug (singular snake_case)
|
|
58
|
+
3. Call `create_fields` with all custom fields (default fields already exist)
|
|
59
|
+
4. For select/tagSelect/status fields, call `create_enums` with the field ID from step 3
|
|
60
|
+
5. Call `regenerate_openapi_spec` to update the OpenAPI spec
|
|
61
|
+
|
|
62
|
+
**Batch approach (recommended for multiple data sources):**
|
|
63
|
+
1. Call `get_apps` to find the target app ID (optional, defaults to "Default Customizations App")
|
|
64
|
+
2. Call `create_data_sources_batch` with an array of data source definitions (max 20)
|
|
65
|
+
- Each data source includes `title`, `name`, `slug`, and `fields` array
|
|
66
|
+
- Fields can include inline `enumOptions` for select/status/tagSelect fields
|
|
67
|
+
- Use slug references for `relationDataSourceId` to reference other data sources in the same batch
|
|
68
|
+
- All data sources, fields, and enums are created in a single atomic transaction
|
|
69
|
+
3. Call `regenerate_openapi_spec` to update the OpenAPI spec
|
|
70
|
+
|
|
71
|
+
### Query Data
|
|
72
|
+
|
|
73
|
+
1. Call `get_data_source_metadata` to discover field slugs, types, and relations
|
|
74
|
+
2. Call `query_data_source` with appropriate columns, filters, and sorting
|
|
75
|
+
3. For advanced queries (aggregations, formulas, pivots, child queries), read [references/data-source-query-guide.md](references/data-source-query-guide.md)
|
|
76
|
+
|
|
77
|
+
### Modify Existing Data Source
|
|
78
|
+
|
|
79
|
+
1. Call `get_data_source_metadata` to see current fields
|
|
80
|
+
2. Use `create_fields` / `update_fields` / `delete_fields` as needed
|
|
81
|
+
3. For enum changes, use `get_enums_by_field_id` first, then `create_enums` / `update_enums` / `delete_enums`
|
|
82
|
+
4. Call `regenerate_openapi_spec` to update the OpenAPI spec
|
|
83
|
+
|
|
84
|
+
### Manage a Custom Query Lifecycle
|
|
85
|
+
|
|
86
|
+
1. Call `get_custom_queries` to find an existing query or confirm naming
|
|
87
|
+
2. Call `create_custom_query` with `name`, `query`, and optional `description`/`filters`
|
|
88
|
+
3. Call `get_custom_query_by_id` to verify the saved template and filter definitions
|
|
89
|
+
4. Use `update_custom_query` for targeted edits (rename, revise SQL template, update filter definitions)
|
|
90
|
+
5. Use `delete_custom_query` only when archival is explicitly requested
|
|
91
|
+
|
|
92
|
+
### Run and Debug a Custom Query
|
|
93
|
+
|
|
94
|
+
1. Call `get_custom_query_by_id` first to inspect SQL template and available filter slugs
|
|
95
|
+
2. Build runtime `filters` with `rules[].field` values that match the query's filter slugs
|
|
96
|
+
3. Call `run_custom_query` with `simulate: true` for complex or untrusted queries to inspect plan output
|
|
97
|
+
4. Call `run_custom_query` with `simulate: false` (or omitted) to fetch real data
|
|
98
|
+
5. Use `offset` for pagination and expect a max of 50,000 rows per execution
|
|
99
|
+
|
|
100
|
+
## Key Rules
|
|
101
|
+
|
|
102
|
+
### Data Source Creation
|
|
103
|
+
- `title` is plural (e.g., "Sales Orders"), `name` is singular (e.g., "Sales Order"), `slug` is singular snake_case (e.g., "sales_order")
|
|
104
|
+
- Use `defaultEditFormTarget: "tab"` for complex forms, `"side"` for simple ones
|
|
105
|
+
- Enable `pluginActivityView` for CRM-type data sources (leads, contacts, deals)
|
|
106
|
+
- Enable `pluginComments` for collaborative data sources
|
|
107
|
+
- Enable `pluginFile` when users need to attach files to records
|
|
108
|
+
- Enable `pluginDocyment` when users need rich text documents per record
|
|
109
|
+
|
|
110
|
+
### Field Types
|
|
111
|
+
- `field-relation` requires `relationDataSourceId` — the ID (UUID) of the related data source, or in batch operations, the slug of another data source in the same batch
|
|
112
|
+
- `field-list` is a virtual field showing child records (one-to-many) — not stored in DB
|
|
113
|
+
- `field-select` / `field-tagSelect` / `field-status` need enum options:
|
|
114
|
+
- In `create_fields`: call `create_enums` after field creation
|
|
115
|
+
- In `create_data_sources_batch`: include inline `enumOptions` array in the field definition
|
|
116
|
+
- `field-formula` uses JSONata expressions — test with `evaluate_jsonata` first
|
|
117
|
+
- `field-inlineData` stores array of objects, `field-inlineForm` stores single nested object
|
|
118
|
+
- Field `slug` must be snake_case matching `^[a-z][a-z0-9_]*$`
|
|
119
|
+
- Enum option `slug` must be snake_case matching `^[a-z][a-z0-9_]*$` (auto-generated from name if not provided)
|
|
120
|
+
|
|
121
|
+
### Batch Operations
|
|
122
|
+
- `create_data_sources_batch` creates up to 20 data sources in a single transaction
|
|
123
|
+
- Within a batch, reference other data sources using their `slug` for `relationDataSourceId`
|
|
124
|
+
- For external data sources (created outside the batch), use the UUID for `relationDataSourceId`
|
|
125
|
+
- Data source slugs must be unique within the batch (validation error otherwise)
|
|
126
|
+
- Inline enum options are defined per-field using the `enumOptions` array
|
|
127
|
+
- Each enum option in `enumOptions` can specify: `name`, `slug`, `color`, `icon`, `sortOrder`
|
|
128
|
+
- If a batch operation fails, all changes are rolled back (atomic transaction)
|
|
129
|
+
- Use batch operations when creating related data sources to avoid multiple API calls and ensure consistency
|
|
130
|
+
|
|
131
|
+
### Querying
|
|
132
|
+
- Use `dataSourceId` (UUID) to identify which data source to query
|
|
133
|
+
- `columns` is a comma-separated string of field slugs, not an array
|
|
134
|
+
- For aggregations, always use `id` field for `count` calculations
|
|
135
|
+
- Relation expansion: `relation_field(sub_field1, sub_field2)` selects nested columns
|
|
136
|
+
- Spread operator: `...relation_field(alias:sub_field)` flattens into root object
|
|
137
|
+
- Filter on related fields: `rel_{{relation_slug}}/{{field_slug}}`
|
|
138
|
+
- Date filters have shortcut operators like `today`, `this_month`, `last_30_days`
|
|
139
|
+
|
|
140
|
+
### query_data_source Required Parameters
|
|
141
|
+
All parameters are required in the MCP tool schema (most accept `null`):
|
|
142
|
+
- `dataSourceId`: string (required, non-null)
|
|
143
|
+
- `columns`: string | null
|
|
144
|
+
- `filters`: object | null
|
|
145
|
+
- `filterKeyword`: string | null
|
|
146
|
+
- `orderBy`: array | null
|
|
147
|
+
- `limit`: number | null (default: 1000)
|
|
148
|
+
- `offset`: number | null
|
|
149
|
+
- `fullCount`: boolean | null
|
|
150
|
+
- `recordId`: string | null (fetch single record by ID)
|
|
151
|
+
- `calculations`: array | null
|
|
152
|
+
- `distinctColumns`: array | null
|
|
153
|
+
- `formulas`: array | null
|
|
154
|
+
- `childQueries`: array | null
|
|
155
|
+
- `pivot`: object | null
|
|
156
|
+
|
|
157
|
+
### Custom Query Rules
|
|
158
|
+
- Treat custom query `query` content as a Handlebars SQL template, not static SQL.
|
|
159
|
+
- Use built-in context variables in templates when relevant: `TENANT_ID`, `TENANT_SCHEMA`, `USER_ID`, `USER_EMAIL`, `USER_FIRSTNAME`, `USER_LASTNAME`, `USER_FULLNAME`.
|
|
160
|
+
- Use `{{filter FILTERS.<slug> <column_expression>}}` for optional runtime filtering. If no runtime value is provided, the helper resolves to `1=1`.
|
|
161
|
+
- Keep `filters` definitions in `create_custom_query` / `update_custom_query` aligned with template usage:
|
|
162
|
+
- template usage: `FILTERS.<slug>`
|
|
163
|
+
- runtime rule field: `<slug>`
|
|
164
|
+
- filter definition slug: `<slug>`
|
|
165
|
+
- Prefer `simulate: true` before running expensive queries to inspect `EXPLAIN (ANALYZE, BUFFERS, FORMAT JSON)` output.
|
|
166
|
+
- Respect runtime limits on `run_custom_query`: 50,000 row cap, 15s timeout for normal execution, 30s timeout for simulate mode.
|
|
167
|
+
- Use `delete_custom_query` as an archival action (soft delete), not permanent deletion.
|
|
168
|
+
- For JSONB-backed simple data sources, access custom fields with `(table_alias."data"->>'field-uuid')::type`.
|
|
169
|
+
|
|
170
|
+
## References
|
|
171
|
+
|
|
172
|
+
- **[Data Source Query Guide](references/data-source-query-guide.md)** — Up-to-date reference for `query_data_source` including columns, filters, orderBy, pagination, calculations, formulas, pivots, child queries, and operator details.
|
|
173
|
+
- **[Formula Design Guide (LLM)](references/formula-design-guide-llm.md)** — Up-to-date guide for designing formula payloads used in query requests.
|
|
174
|
+
- **[Custom Query Guide](references/custom-query-guide.md)** — Full lifecycle and execution reference for `get_custom_queries`, `get_custom_query_by_id`, `create_custom_query`, `update_custom_query`, `delete_custom_query`, and `run_custom_query`.
|