@docyrus/docyrus 0.0.16 → 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.
Files changed (41) hide show
  1. package/README.md +25 -2
  2. package/main.js +867 -505
  3. package/main.js.map +4 -4
  4. package/package.json +2 -1
  5. package/resources/pi-agent/prompts/agent-system.md +25 -0
  6. package/resources/pi-agent/prompts/coder-append-system.md +19 -0
  7. package/resources/pi-agent/skills/docyrus-ai/SKILL.md +28 -0
  8. package/resources/pi-agent/skills/docyrus-api-dev/SKILL.md +161 -0
  9. package/resources/pi-agent/skills/docyrus-api-dev/references/api-client.md +349 -0
  10. package/resources/pi-agent/skills/docyrus-api-dev/references/authentication.md +238 -0
  11. package/resources/pi-agent/skills/docyrus-api-dev/references/data-source-query-guide.md +2059 -0
  12. package/resources/pi-agent/skills/docyrus-api-dev/references/formula-design-guide-llm.md +320 -0
  13. package/resources/pi-agent/skills/docyrus-api-dev/references/query-and-formulas.md +592 -0
  14. package/resources/pi-agent/skills/docyrus-api-doctor/SKILL.md +70 -0
  15. package/resources/pi-agent/skills/docyrus-api-doctor/references/checklist-details.md +588 -0
  16. package/resources/pi-agent/skills/docyrus-app-dev/SKILL.md +159 -0
  17. package/resources/pi-agent/skills/docyrus-app-dev/references/api-client-and-auth.md +275 -0
  18. package/resources/pi-agent/skills/docyrus-app-dev/references/collections-and-patterns.md +352 -0
  19. package/resources/pi-agent/skills/docyrus-app-dev/references/data-source-query-guide.md +2059 -0
  20. package/resources/pi-agent/skills/docyrus-app-dev/references/formula-design-guide-llm.md +320 -0
  21. package/resources/pi-agent/skills/docyrus-app-dev/references/query-guide.md +525 -0
  22. package/resources/pi-agent/skills/docyrus-app-ui-design/SKILL.md +466 -0
  23. package/resources/pi-agent/skills/docyrus-app-ui-design/references/component-selection-guide.md +602 -0
  24. package/resources/pi-agent/skills/docyrus-app-ui-design/references/icon-usage-guide.md +463 -0
  25. package/resources/pi-agent/skills/docyrus-app-ui-design/references/preferred-components-catalog.md +242 -0
  26. package/resources/pi-agent/skills/docyrus-apps/SKILL.md +54 -0
  27. package/resources/pi-agent/skills/docyrus-architect/SKILL.md +174 -0
  28. package/resources/pi-agent/skills/docyrus-architect/references/custom-query-guide.md +410 -0
  29. package/resources/pi-agent/skills/docyrus-architect/references/data-source-query-guide.md +2059 -0
  30. package/resources/pi-agent/skills/docyrus-architect/references/formula-design-guide-llm.md +320 -0
  31. package/resources/pi-agent/skills/docyrus-architect/references/formula-reference.md +145 -0
  32. package/resources/pi-agent/skills/docyrus-auth/SKILL.md +100 -0
  33. package/resources/pi-agent/skills/docyrus-cli-app/SKILL.md +279 -0
  34. package/resources/pi-agent/skills/docyrus-cli-app/references/cli-manifest.md +532 -0
  35. package/resources/pi-agent/skills/docyrus-cli-app/references/list-query-examples.md +248 -0
  36. package/resources/pi-agent/skills/docyrus-curl/SKILL.md +32 -0
  37. package/resources/pi-agent/skills/docyrus-discover/SKILL.md +63 -0
  38. package/resources/pi-agent/skills/docyrus-ds/SKILL.md +95 -0
  39. package/resources/pi-agent/skills/docyrus-env/SKILL.md +21 -0
  40. package/resources/pi-agent/skills/docyrus-studio/SKILL.md +369 -0
  41. package/resources/pi-agent/skills/docyrus-tui/SKILL.md +15 -0
@@ -0,0 +1,248 @@
1
+ # List Query Examples
2
+
3
+ Practical examples for `docyrus ds list` with columns, filters, sorting, and pagination.
4
+
5
+ ---
6
+
7
+ ## Table of Contents
8
+
9
+ 1. [Basic Listing](#basic-listing)
10
+ 2. [Column Selection](#column-selection)
11
+ 3. [Filtering](#filtering)
12
+ 4. [Sorting](#sorting)
13
+ 5. [Pagination](#pagination)
14
+ 6. [Combined Examples](#combined-examples)
15
+
16
+ ---
17
+
18
+ ## Basic Listing
19
+
20
+ List all records with default columns:
21
+
22
+ ```bash
23
+ docyrus ds list crm contacts
24
+ ```
25
+
26
+ List with JSON output:
27
+
28
+ ```bash
29
+ docyrus ds list crm contacts --format json
30
+ ```
31
+
32
+ ---
33
+
34
+ ## Column Selection
35
+
36
+ Select specific fields:
37
+
38
+ ```bash
39
+ docyrus ds list crm contacts --columns "name, email, phone"
40
+ ```
41
+
42
+ Select with relation expansion (get related account's name):
43
+
44
+ ```bash
45
+ docyrus ds list crm contacts --columns "name, email, related_account(account_name)"
46
+ ```
47
+
48
+ Spread related fields into root object:
49
+
50
+ ```bash
51
+ docyrus ds list crm contacts --columns "name, ...related_account(account_name, account_phone)"
52
+ ```
53
+
54
+ Alias columns:
55
+
56
+ ```bash
57
+ docyrus ds list crm contacts --columns "n:name, e:email, p:phone"
58
+ ```
59
+
60
+ ---
61
+
62
+ ## Filtering
63
+
64
+ ### Single field equals
65
+
66
+ ```bash
67
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"status","operator":"=","value":"active"}]}'
68
+ ```
69
+
70
+ ### Multiple conditions (AND)
71
+
72
+ ```bash
73
+ docyrus ds list crm contacts --filters '{"combinator":"and","rules":[{"field":"status","operator":"=","value":"active"},{"field":"priority","operator":">=","value":3}]}'
74
+ ```
75
+
76
+ ### OR conditions
77
+
78
+ ```bash
79
+ docyrus ds list crm contacts --filters '{"combinator":"or","rules":[{"field":"city","operator":"=","value":"Istanbul"},{"field":"city","operator":"=","value":"Ankara"}]}'
80
+ ```
81
+
82
+ ### IN operator (match any value in list)
83
+
84
+ ```bash
85
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"status","operator":"in","value":[1,2,3]}]}'
86
+ ```
87
+
88
+ ### Not equal
89
+
90
+ ```bash
91
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"status","operator":"!=","value":"archived"}]}'
92
+ ```
93
+
94
+ ### Text search with LIKE
95
+
96
+ ```bash
97
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"name","operator":"like","value":"John"}]}'
98
+ ```
99
+
100
+ ### Empty / not empty
101
+
102
+ ```bash
103
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"email","operator":"not empty"}]}'
104
+ ```
105
+
106
+ ```bash
107
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"phone","operator":"empty"}]}'
108
+ ```
109
+
110
+ ### Date shortcuts
111
+
112
+ Records created this month:
113
+
114
+ ```bash
115
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"created_on","operator":"this_month"}]}'
116
+ ```
117
+
118
+ Records created today:
119
+
120
+ ```bash
121
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"created_on","operator":"today"}]}'
122
+ ```
123
+
124
+ Records from last 30 days:
125
+
126
+ ```bash
127
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"created_on","operator":"last_30_days"}]}'
128
+ ```
129
+
130
+ ### Date range with between
131
+
132
+ ```bash
133
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"created_on","operator":"between","value":["2025-01-01","2025-06-30"]}]}'
134
+ ```
135
+
136
+ ### Filter on related field
137
+
138
+ Filter by related account's status:
139
+
140
+ ```bash
141
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"rel_related_account/account_status","operator":"=","value":1}]}'
142
+ ```
143
+
144
+ ### Current user filter
145
+
146
+ Records owned by current user:
147
+
148
+ ```bash
149
+ docyrus ds list crm contacts --filters '{"rules":[{"field":"record_owner","operator":"active_user"}]}'
150
+ ```
151
+
152
+ ### Nested AND + OR
153
+
154
+ Active contacts created this month OR contacts with high priority:
155
+
156
+ ```bash
157
+ docyrus ds list crm contacts --filters '{"combinator":"or","rules":[{"combinator":"and","rules":[{"field":"status","operator":"=","value":"active"},{"field":"created_on","operator":"this_month"}]},{"field":"priority","operator":">=","value":5}]}'
158
+ ```
159
+
160
+ ---
161
+
162
+ ## Sorting
163
+
164
+ Sort by name ascending (default):
165
+
166
+ ```bash
167
+ docyrus ds list crm contacts --orderBy "name"
168
+ ```
169
+
170
+ Sort by created date descending:
171
+
172
+ ```bash
173
+ docyrus ds list crm contacts --orderBy "created_on DESC"
174
+ ```
175
+
176
+ ---
177
+
178
+ ## Pagination
179
+
180
+ First 10 records:
181
+
182
+ ```bash
183
+ docyrus ds list crm contacts --limit 10
184
+ ```
185
+
186
+ Next 10 records (page 2):
187
+
188
+ ```bash
189
+ docyrus ds list crm contacts --limit 10 --offset 10
190
+ ```
191
+
192
+ Get total count alongside results:
193
+
194
+ ```bash
195
+ docyrus ds list crm contacts --limit 10 --fullCount true
196
+ ```
197
+
198
+ ---
199
+
200
+ ## Combined Examples
201
+
202
+ ### Active contacts with email, sorted by name, paginated
203
+
204
+ ```bash
205
+ docyrus ds list crm contacts \
206
+ --columns "name, email, phone, created_on" \
207
+ --filters '{"rules":[{"field":"status","operator":"=","value":"active"},{"field":"email","operator":"not empty"}]}' \
208
+ --orderBy "name" \
209
+ --limit 25 \
210
+ --fullCount true
211
+ ```
212
+
213
+ ### Recent high-priority deals with account info
214
+
215
+ ```bash
216
+ docyrus ds list crm deals \
217
+ --columns "name, amount, stage, ...related_account(account_name)" \
218
+ --filters '{"combinator":"and","rules":[{"field":"priority","operator":">=","value":4},{"field":"created_on","operator":"last_30_days"}]}' \
219
+ --orderBy "amount DESC" \
220
+ --limit 20
221
+ ```
222
+
223
+ ### Search for records by keyword
224
+
225
+ ```bash
226
+ docyrus ds list crm contacts \
227
+ --columns "name, email, phone" \
228
+ --filters '{"rules":[{"field":"name","operator":"like","value":"Smith"}]}' \
229
+ --format json
230
+ ```
231
+
232
+ ### Export all records as JSON lines
233
+
234
+ ```bash
235
+ docyrus ds list crm contacts \
236
+ --columns "id, name, email, phone, status, created_on" \
237
+ --format jsonl
238
+ ```
239
+
240
+ ### Records owned by current user, created this quarter
241
+
242
+ ```bash
243
+ docyrus ds list crm tasks \
244
+ --columns "name, status, priority, due_date" \
245
+ --filters '{"combinator":"and","rules":[{"field":"record_owner","operator":"active_user"},{"field":"created_on","operator":"this_quarter"}]}' \
246
+ --orderBy "due_date" \
247
+ --limit 50
248
+ ```
@@ -0,0 +1,32 @@
1
+ ---
2
+ name: docyrus-curl
3
+ description: Send arbitrary requests to Docyrus API. Run `docyrus curl --help` for usage details.
4
+ command: docyrus curl
5
+ ---
6
+
7
+ # docyrus curl
8
+
9
+ Send arbitrary requests to Docyrus API
10
+
11
+ ## Arguments
12
+
13
+ | Name | Type | Required | Description |
14
+ |------|------|----------|-------------|
15
+ | `path` | `string` | yes | API path (no absolute URL) |
16
+
17
+ ## Environment Variables
18
+
19
+ | Name | Type | Required | Default | Description |
20
+ |------|------|----------|---------|-------------|
21
+ | `DOCYRUS_API_CLIENT_ID` | `string` | no | | Default Docyrus OAuth2 client id |
22
+
23
+ ## Options
24
+
25
+ | Flag | Type | Default | Description |
26
+ |------|------|---------|-------------|
27
+ | `--request` | `string` | | HTTP method |
28
+ | `--header` | `array` | | Request header (repeatable) |
29
+ | `--data` | `string` | | Request payload |
30
+ | `--get` | `boolean` | | Send data as query string |
31
+ | `--include` | `boolean` | | Include status and response headers |
32
+ | `--noAuth` | `boolean` | | Skip Authorization header |
@@ -0,0 +1,63 @@
1
+ ---
2
+ name: docyrus-discover
3
+ description: Discovery commands. Download tenant OpenAPI spec for the active tenant, Return full endpoint object for a path and HTTP method, Return full entity object by name, List API namespaces from active tenant OpenAPI spec, List endpoints with method and description for matching path prefix, Search endpoint paths and entity names (endpoint results include method and description). Run `docyrus discover --help` for usage details.
4
+ command: docyrus discover
5
+ ---
6
+
7
+ # docyrus discover api
8
+
9
+ Download tenant OpenAPI spec for the active tenant
10
+
11
+ ---
12
+
13
+ # docyrus discover endpoint
14
+
15
+ Return full endpoint object for a path and HTTP method
16
+
17
+ ## Arguments
18
+
19
+ | Name | Type | Required | Description |
20
+ |------|------|----------|-------------|
21
+ | `selector` | `string` | yes | Endpoint selector, e.g. /v1/users/me or [PUT]/v1/users/me/photo |
22
+
23
+ ---
24
+
25
+ # docyrus discover entity
26
+
27
+ Return full entity object by name
28
+
29
+ ## Arguments
30
+
31
+ | Name | Type | Required | Description |
32
+ |------|------|----------|-------------|
33
+ | `name` | `string` | yes | Entity name, e.g. UserEntity |
34
+
35
+ ---
36
+
37
+ # docyrus discover namespaces
38
+
39
+ List API namespaces from active tenant OpenAPI spec
40
+
41
+ ---
42
+
43
+ # docyrus discover path
44
+
45
+ List endpoints with method and description for matching path prefix
46
+
47
+ ## Arguments
48
+
49
+ | Name | Type | Required | Description |
50
+ |------|------|----------|-------------|
51
+ | `prefix` | `string` | yes | Path prefix, e.g. /v1/users |
52
+
53
+ ---
54
+
55
+ # docyrus discover search
56
+
57
+ Search endpoint paths and entity names (endpoint results include method and description)
58
+
59
+ ## Arguments
60
+
61
+ | Name | Type | Required | Description |
62
+ |------|------|----------|-------------|
63
+ | `query` | `string` | yes | One or more comma-separated search strings |
@@ -0,0 +1,95 @@
1
+ ---
2
+ name: docyrus-ds
3
+ description: Data source commands. Create a data source item, Delete a data source item, Get data source metadata, List data source items, Update a data source item. Run `docyrus ds --help` for usage details.
4
+ command: docyrus ds
5
+ ---
6
+
7
+ # docyrus ds create
8
+
9
+ Create a data source item
10
+
11
+ ## Arguments
12
+
13
+ | Name | Type | Required | Description |
14
+ |------|------|----------|-------------|
15
+ | `appSlug` | `string` | yes | |
16
+ | `dataSourceSlug` | `string` | yes | |
17
+
18
+ ## Options
19
+
20
+ | Flag | Type | Default | Description |
21
+ |------|------|---------|-------------|
22
+ | `--data` | `string` | | JSON payload for record fields |
23
+ | `--fromFile` | `string` | | Path to JSON or CSV payload file |
24
+
25
+ ---
26
+
27
+ # docyrus ds delete
28
+
29
+ Delete a data source item
30
+
31
+ ## Arguments
32
+
33
+ | Name | Type | Required | Description |
34
+ |------|------|----------|-------------|
35
+ | `appSlug` | `string` | yes | |
36
+ | `dataSourceSlug` | `string` | yes | |
37
+ | `recordId` | `string` | yes | |
38
+
39
+ ---
40
+
41
+ # docyrus ds get
42
+
43
+ Get data source metadata
44
+
45
+ ## Arguments
46
+
47
+ | Name | Type | Required | Description |
48
+ |------|------|----------|-------------|
49
+ | `appSlug` | `string` | yes | |
50
+ | `dataSourceSlug` | `string` | yes | |
51
+
52
+ ---
53
+
54
+ # docyrus ds list
55
+
56
+ List data source items
57
+
58
+ ## Arguments
59
+
60
+ | Name | Type | Required | Description |
61
+ |------|------|----------|-------------|
62
+ | `appSlug` | `string` | yes | |
63
+ | `dataSourceSlug` | `string` | yes | |
64
+
65
+ ## Options
66
+
67
+ | Flag | Type | Default | Description |
68
+ |------|------|---------|-------------|
69
+ | `--columns` | `string` | | |
70
+ | `--filters` | `string` | | |
71
+ | `--limit` | `number` | | |
72
+ | `--offset` | `number` | | |
73
+ | `--orderBy` | `string` | | |
74
+ | `--fullCount` | `boolean` | | |
75
+
76
+ ---
77
+
78
+ # docyrus ds update
79
+
80
+ Update a data source item
81
+
82
+ ## Arguments
83
+
84
+ | Name | Type | Required | Description |
85
+ |------|------|----------|-------------|
86
+ | `appSlug` | `string` | yes | |
87
+ | `dataSourceSlug` | `string` | yes | |
88
+ | `recordId` | `string` | no | |
89
+
90
+ ## Options
91
+
92
+ | Flag | Type | Default | Description |
93
+ |------|------|---------|-------------|
94
+ | `--data` | `string` | | JSON payload for record fields |
95
+ | `--fromFile` | `string` | | Path to JSON or CSV payload file |
@@ -0,0 +1,21 @@
1
+ ---
2
+ name: docyrus-env
3
+ description: Environment commands. List available environments, Switch active environment by id or name. Run `docyrus env --help` for usage details.
4
+ command: docyrus env
5
+ ---
6
+
7
+ # docyrus env list
8
+
9
+ List available environments
10
+
11
+ ---
12
+
13
+ # docyrus env use
14
+
15
+ Switch active environment by id or name
16
+
17
+ ## Arguments
18
+
19
+ | Name | Type | Required | Description |
20
+ |------|------|----------|-------------|
21
+ | `selector` | `string` | yes | Environment id or name |