@culvii/cli 0.0.8 → 0.0.9

package/skills/culvii/references/node-argocd.md

@@ -0,0 +1,44 @@
+# argocd
+
+- Type ID: `argocd`
+- Kind: `action`
+- Credentials: required as `credentials: { name, id }`; `name` must be one of: `argocd`
+- Feedback mock: required
+
+Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
+
+## Props
+
+- `resource`: options; required
+  - Values: `application`, `project`
+- `operation`: options; required; when resource=application
+  - Values: `getApplication`, `syncApplication`, `listApplications`, `getResourceTree`
+- `operation`: options; required; when resource=project
+  - Values: `listProjects`
+- `applicationName`: string; required; when resource=application, operation=getApplication
+- `refresh`: options; optional; when resource=application, operation=getApplication
+  - Values: ``, `normal`, `hard`
+- `applicationName`: string; required; when resource=application, operation=syncApplication
+- `revision`: string; optional; when resource=application, operation=syncApplication
+- `prune`: boolean; optional; when resource=application, operation=syncApplication
+- `dryRun`: boolean; optional; when resource=application, operation=syncApplication
+- `strategy`: options; optional; when resource=application, operation=syncApplication
+  - Values: `hook`, `apply`
+- `force`: boolean; optional; when resource=application, operation=syncApplication, strategy=apply
+- `project`: string; optional; when resource=application, operation=listApplications
+- `applicationName`: string; required; when resource=application, operation=getResourceTree
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'argocd',
+  name: 'argocd',
+  type: 'argocd',
+  credentials: { name: 'argocd', id: 'credential-id' },
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii argocd node](https://culvii.com/docs/nodes/argocd/).

package/skills/culvii/references/node-clickup-doc.md

@@ -0,0 +1,38 @@
+# clickupDoc
+
+- Type ID: `clickupDoc`
+- Kind: `action`
+- Credentials: required as `credentials: { name, id }`; `name` must be one of: `clickup`
+- Feedback mock: required
+
+Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
+
+## Props
+
+- `resource`: options; required
+  - Values: `doc`
+- `operation`: options; required; when resource=doc
+  - Values: `create`, `read`
+- `workspaceId`: string; required; when resource=doc, operation=create
+- `name`: string; required; when resource=doc, operation=create
+- `parentType`: options; required; when resource=doc, operation=create
+  - Values: `12`, `4`, `5`, `6`
+- `parentId`: string; optional; when resource=doc, operation=create
+- `content`: string; optional; when resource=doc, operation=create
+- `workspaceId`: string; required; when resource=doc, operation=read
+- `docId`: string; required; when resource=doc, operation=read
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'clickup-doc',
+  name: 'clickupDoc',
+  type: 'clickupDoc',
+  credentials: { name: 'clickup', id: 'credential-id' },
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii clickupDoc node](https://culvii.com/docs/nodes/clickup-doc/).

package/skills/culvii/references/node-clickup-ticket.md

@@ -0,0 +1,47 @@
+# clickupTicket
+
+- Type ID: `clickupTicket`
+- Kind: `action`
+- Credentials: required as `credentials: { name, id }`; `name` must be one of: `clickup`
+- Feedback mock: required
+
+Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
+
+## Props
+
+- `resource`: options; required
+  - Values: `ticket`
+- `operation`: options; required; when resource=ticket
+  - Values: `create`, `update`, `updateStatus`, `updateDescription`
+- `listId`: string; required; when resource=ticket, operation=create
+- `name`: string; required; when resource=ticket, operation=create
+- `description`: string; optional; when resource=ticket, operation=create
+- `status`: string; optional; when resource=ticket, operation=create
+- `assignees`: string; optional; when resource=ticket, operation=create
+- `priority`: options; optional; when resource=ticket, operation=create
+  - Values: ``, `1`, `2`, `3`, `4`
+- `taskId`: string; required; when resource=ticket, operation=update
+- `name`: string; optional; when resource=ticket, operation=update
+- `description`: string; optional; when resource=ticket, operation=update
+- `status`: string; optional; when resource=ticket, operation=update
+- `priority`: options; optional; when resource=ticket, operation=update
+  - Values: ``, `1`, `2`, `3`, `4`
+- `taskId`: string; required; when resource=ticket, operation=updateStatus
+- `status`: string; required; when resource=ticket, operation=updateStatus
+- `taskId`: string; required; when resource=ticket, operation=updateDescription
+- `description`: string; required; when resource=ticket, operation=updateDescription
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'clickup-ticket',
+  name: 'clickupTicket',
+  type: 'clickupTicket',
+  credentials: { name: 'clickup', id: 'credential-id' },
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii clickupTicket node](https://culvii.com/docs/nodes/clickup-ticket/).

package/skills/culvii/references/node-core-loop-break.md

@@ -0,0 +1,26 @@
+# core.loopBreak
+
+- Type ID: `core.loopBreak`
+- Kind: `action`
+- Credentials: not required
+- Feedback mock: not required
+
+## Props
+
+- `conditions`: array; required
+- `combineOperation`: options; required
+  - Values: `all`, `any`
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'core-loop-break',
+  name: 'core.loopBreak',
+  type: 'core.loopBreak',
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii core.loopBreak node](https://culvii.com/docs/nodes/core/loop-break/).

package/skills/culvii/references/node-core-loop-continue.md

@@ -0,0 +1,26 @@
+# core.loopContinue
+
+- Type ID: `core.loopContinue`
+- Kind: `action`
+- Credentials: not required
+- Feedback mock: not required
+
+## Props
+
+- `conditions`: array; required
+- `combineOperation`: options; required
+  - Values: `all`, `any`
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'core-loop-continue',
+  name: 'core.loopContinue',
+  type: 'core.loopContinue',
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii core.loopContinue node](https://culvii.com/docs/nodes/core/loop-continue/).

package/skills/culvii/references/node-core-loop-output.md

@@ -0,0 +1,24 @@
+# core.loopOutput
+
+- Type ID: `core.loopOutput`
+- Kind: `action`
+- Credentials: not required
+- Feedback mock: not required
+
+## Props
+
+- `values`: object; required
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'core-loop-output',
+  name: 'core.loopOutput',
+  type: 'core.loopOutput',
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii core.loopOutput node](https://culvii.com/docs/nodes/core/loop-output/).

package/skills/culvii/references/node-core-loop.md

@@ -0,0 +1,25 @@
+# core.loop
+
+- Type ID: `core.loop`
+- Kind: `action`
+- Credentials: not required
+- Feedback mock: not required
+
+## Props
+
+- `items`: array; required
+- `parallel`: boolean; required
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'core-loop',
+  name: 'core.loop',
+  type: 'core.loop',
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii core.loop node](https://culvii.com/docs/nodes/core/loop/).

package/skills/culvii/references/node-core-merge.md

@@ -0,0 +1,23 @@
+# core.merge
+
+- Type ID: `core.merge`
+- Kind: `action`
+- Credentials: not required
+- Feedback mock: not required
+
+## Props
+
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'core-merge',
+  name: 'core.merge',
+  type: 'core.merge',
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii core.merge node](https://culvii.com/docs/nodes/core/merge/).

package/skills/culvii/references/node-core-switch.md

@@ -0,0 +1,24 @@
+# core.switch
+
+- Type ID: `core.switch`
+- Kind: `action`
+- Credentials: not required
+- Feedback mock: not required
+
+## Props
+
+- `rules`: array; required
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'core-switch',
+  name: 'core.switch',
+  type: 'core.switch',
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii core.switch node](https://culvii.com/docs/nodes/core/switch/).

package/skills/culvii/references/node-cost-explorer.md

@@ -0,0 +1,45 @@
+# costExplorer
+
+- Type ID: `costExplorer`
+- Kind: `action`
+- Credentials: required as `credentials: { name, id }`; `name` must be one of: `aws_cost_explorer`
+- Feedback mock: required
+
+Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
+
+## Props
+
+- `resource`: options; required
+  - Values: `costAndUsage`
+- `operation`: options; required; when resource=costAndUsage
+  - Values: `get`
+- `dateRange`: options; required; when resource=costAndUsage, operation=get
+  - Values: `yesterday`, `last7Days`, `last30Days`, `monthToDate`, `lastMonth`, `custom`
+- `startDate`: string; required; when resource=costAndUsage, operation=get, dateRange=custom
+- `endDate`: string; required; when resource=costAndUsage, operation=get, dateRange=custom
+- `granularity`: options; required; when resource=costAndUsage, operation=get
+  - Values: `DAILY`, `MONTHLY`
+- `metric`: options; required; when resource=costAndUsage, operation=get
+  - Values: `NetUnblendedCost`, `NetAmortizedCost`, `UnblendedCost`, `BlendedCost`, `AmortizedCost`
+- `groupBy`: json; optional; when resource=costAndUsage, operation=get
+- `services`: json; optional; when resource=costAndUsage, operation=get
+- `accountIds`: json; optional; when resource=costAndUsage, operation=get
+- `filterExpression`: json; optional; when resource=costAndUsage, operation=get
+- `outputFormat`: options; required; when resource=costAndUsage, operation=get
+  - Values: `simple`, `raw`
+- `limit`: number; optional; when resource=costAndUsage, operation=get
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'cost-explorer',
+  name: 'costExplorer',
+  type: 'costExplorer',
+  credentials: { name: 'aws_cost_explorer', id: 'credential-id' },
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii costExplorer node](https://culvii.com/docs/nodes/cost-explorer/).

package/skills/culvii/references/node-elasticsearch.md

@@ -2,7 +2,7 @@
 
 - Type ID: `elasticsearch`
 - Kind: `action`
-- Credentials: required as `credentials: { name, id }`
+- Credentials: required as `credentials: { name, id }`; `name` must be one of: `elasticsearch`
 - Feedback mock: required
 
 Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
@@ -31,7 +31,7 @@ new Step({
   id: 'elasticsearch',
   name: 'elasticsearch',
   type: 'elasticsearch',
-  credentials: { name: 'Stored credential', id: 'credential-id' },
+  credentials: { name: 'elasticsearch', id: 'credential-id' },
   params: { /* use the required props and conditional values above */ },
 });
 ```

package/skills/culvii/references/node-github-poll-trigger.md

@@ -0,0 +1,31 @@
+# githubPollTrigger
+
+- Type ID: `githubPollTrigger`
+- Kind: `trigger`
+- Credentials: required as `credentials: { name, id }`; `name` must be one of: `github`, `github_oauth`, `github_app`
+- Feedback mock: required
+
+Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
+
+## Props
+
+- `pollIntervalMs`: number; required
+- `owner`: string; required
+- `repo`: string; required
+- `watch`: options; required
+  - Values: `pullRequest`, `issue`
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'github-poll-trigger',
+  name: 'githubPollTrigger',
+  type: 'githubPollTrigger',
+  credentials: { name: 'github', id: 'credential-id' },
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii githubPollTrigger node](https://culvii.com/docs/nodes/triggers/github-poll-trigger/).

package/skills/culvii/references/node-github-webhook-trigger.md

@@ -0,0 +1,27 @@
+# githubWebhookTrigger
+
+- Type ID: `githubWebhookTrigger`
+- Kind: `trigger`
+- Credentials: required as `credentials: { name, id }`; `name` must be one of: `github_webhook`
+- Feedback mock: required
+
+Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
+
+## Props
+
+- `method`: string; required
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'github-webhook-trigger',
+  name: 'githubWebhookTrigger',
+  type: 'githubWebhookTrigger',
+  credentials: { name: 'github_webhook', id: 'credential-id' },
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii githubWebhookTrigger node](https://culvii.com/docs/nodes/triggers/github-webhook-trigger/).

package/skills/culvii/references/node-github.md

@@ -0,0 +1,251 @@
+# github
+
+- Type ID: `github`
+- Kind: `action`
+- Credentials: required as `credentials: { name, id }`; `name` must be one of: `github`, `github_oauth`, `github_app`
+- Feedback mock: required
+
+Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
+
+## Props
+
+- `resource`: options; required
+  - Values: `pullRequest`, `branch`, `issue`, `repo`, `org`, `gitBlob`, `gitTree`, `gitCommit`, `commitStatus`, `file`, `action`, `search`
+- `operation`: options; required; when resource=pullRequest
+  - Values: `list`, `get`, `create`, `close`, `merge`, `listComments`, `createComment`, `createInlineComment`, `createReview`, `requestReviewers`
+- `operation`: options; required; when resource=branch
+  - Values: `list`, `get`, `delete`
+- `operation`: options; required; when resource=issue
+  - Values: `create`, `list`, `get`, `update`, `close`, `addLabels`, `createComment`
+- `operation`: options; required; when resource=repo
+  - Values: `getContents`, `create`
+- `operation`: options; required; when resource=org
+  - Values: `list`
+- `operation`: options; required; when resource=gitBlob
+  - Values: `create`, `get`
+- `operation`: options; required; when resource=gitTree
+  - Values: `create`, `get`
+- `operation`: options; required; when resource=gitCommit
+  - Values: `create`
+- `operation`: options; required; when resource=commitStatus
+  - Values: `create`, `list`, `getCombined`
+- `operation`: options; required; when resource=file
+  - Values: `createOrUpdate`
+- `operation`: options; required; when resource=action
+  - Values: `dispatch`
+- `operation`: options; required; when resource=search
+  - Values: `issuesAndPRs`
+- `owner`: string; required; when resource=pullRequest, operation=list
+- `repo`: string; required; when resource=pullRequest, operation=list
+- `state`: options; optional; when resource=pullRequest, operation=list
+  - Values: `open`, `closed`, `all`
+- `limit`: number; required; when resource=pullRequest, operation=list
+- `output`: options; optional; when resource=pullRequest, operation=list
+  - Values: `simple`, `raw`, `fields`
+- `fields`: checkbox; required; when output=fields, resource=pullRequest, operation=list
+  - Values: `id`, `number`, `title`, `state`, `body`, `user`, `base`, `head`, `draft`, `merged`, `mergeable`, `merged_at`, `requested_reviewers`, `labels`, `assignees`, `created_at`, `updated_at`, `closed_at`, `html_url`
+- `owner`: string; required; when resource=pullRequest, operation=close
+- `repo`: string; required; when resource=pullRequest, operation=close
+- `pullNumber`: number; required; when resource=pullRequest, operation=close
+- `owner`: string; required; when resource=pullRequest, operation=create
+- `repo`: string; required; when resource=pullRequest, operation=create
+- `title`: string; required; when resource=pullRequest, operation=create
+- `head`: string; required; when resource=pullRequest, operation=create
+- `base`: string; required; when resource=pullRequest, operation=create
+- `body`: string; optional; when resource=pullRequest, operation=create
+- `draft`: boolean; optional; when resource=pullRequest, operation=create
+- `owner`: string; required; when resource=pullRequest, operation=get
+- `repo`: string; required; when resource=pullRequest, operation=get
+- `pullNumber`: number; required; when resource=pullRequest, operation=get
+- `output`: options; optional; when resource=pullRequest, operation=get
+  - Values: `simple`, `raw`, `fields`
+- `fields`: checkbox; required; when output=fields, resource=pullRequest, operation=get
+  - Values: `id`, `number`, `title`, `state`, `body`, `user`, `base`, `head`, `draft`, `merged`, `mergeable`, `merged_at`, `requested_reviewers`, `labels`, `assignees`, `created_at`, `updated_at`, `closed_at`, `html_url`
+- `owner`: string; required; when resource=pullRequest, operation=merge
+- `repo`: string; required; when resource=pullRequest, operation=merge
+- `pullNumber`: number; required; when resource=pullRequest, operation=merge
+- `mergeMethod`: options; optional; when resource=pullRequest, operation=merge
+  - Values: `merge`, `squash`, `rebase`
+- `commitTitle`: string; optional; when resource=pullRequest, operation=merge
+- `commitMessage`: string; optional; when resource=pullRequest, operation=merge
+- `waitForMergeability`: boolean; optional; when resource=pullRequest, operation=merge
+- `owner`: string; required; when resource=pullRequest, operation=listComments
+- `repo`: string; required; when resource=pullRequest, operation=listComments
+- `pullNumber`: number; required; when resource=pullRequest, operation=listComments
+- `limit`: number; required; when resource=pullRequest, operation=listComments
+- `output`: options; optional; when resource=pullRequest, operation=listComments
+  - Values: `simple`, `raw`, `fields`
+- `fields`: checkbox; required; when output=fields, resource=pullRequest, operation=listComments
+  - Values: `id`, `body`, `user`, `created_at`, `updated_at`, `html_url`
+- `owner`: string; required; when resource=pullRequest, operation=createComment
+- `repo`: string; required; when resource=pullRequest, operation=createComment
+- `pullNumber`: number; required; when resource=pullRequest, operation=createComment
+- `body`: string; required; when resource=pullRequest, operation=createComment
+- `owner`: string; required; when resource=pullRequest, operation=createInlineComment
+- `repo`: string; required; when resource=pullRequest, operation=createInlineComment
+- `pullNumber`: number; required; when resource=pullRequest, operation=createInlineComment
+- `commitId`: string; required; when resource=pullRequest, operation=createInlineComment
+- `path`: string; required; when resource=pullRequest, operation=createInlineComment
+- `line`: number; required; when resource=pullRequest, operation=createInlineComment
+- `start_line`: number; optional; when resource=pullRequest, operation=createInlineComment
+- `side`: options; optional; when resource=pullRequest, operation=createInlineComment
+  - Values: `RIGHT`, `LEFT`
+- `start_side`: options; optional; when resource=pullRequest, operation=createInlineComment
+  - Values: `RIGHT`, `LEFT`
+- `body`: string; required; when resource=pullRequest, operation=createInlineComment
+- `owner`: string; required; when resource=pullRequest, operation=createReview
+- `repo`: string; required; when resource=pullRequest, operation=createReview
+- `pullNumber`: number; required; when resource=pullRequest, operation=createReview
+- `event`: options; required; when resource=pullRequest, operation=createReview
+  - Values: `APPROVE`, `REQUEST_CHANGES`, `COMMENT`
+- `body`: string; optional; when resource=pullRequest, operation=createReview
+- `commitId`: string; optional; when resource=pullRequest, operation=createReview
+- `comments`: json; optional; when resource=pullRequest, operation=createReview
+- `owner`: string; required; when resource=pullRequest, operation=requestReviewers
+- `repo`: string; required; when resource=pullRequest, operation=requestReviewers
+- `pullNumber`: number; required; when resource=pullRequest, operation=requestReviewers
+- `reviewers`: string; optional; when resource=pullRequest, operation=requestReviewers
+- `teamReviewers`: string; optional; when resource=pullRequest, operation=requestReviewers
+- `owner`: string; required; when resource=branch, operation=list
+- `repo`: string; required; when resource=branch, operation=list
+- `limit`: number; required; when resource=branch, operation=list
+- `output`: options; optional; when resource=branch, operation=list
+  - Values: `simple`, `raw`, `fields`
+- `fields`: checkbox; required; when output=fields, resource=branch, operation=list
+  - Values: `name`, `commit`, `protected`, `protection`
+- `owner`: string; required; when resource=branch, operation=delete
+- `repo`: string; required; when resource=branch, operation=delete
+- `branch`: string; required; when resource=branch, operation=delete
+- `owner`: string; required; when resource=branch, operation=get
+- `repo`: string; required; when resource=branch, operation=get
+- `branch`: string; required; when resource=branch, operation=get
+- `output`: options; optional; when resource=branch, operation=get
+  - Values: `simple`, `raw`, `fields`
+- `fields`: checkbox; required; when output=fields, resource=branch, operation=get
+  - Values: `name`, `commit`, `protected`, `protection`
+- `owner`: string; required; when resource=issue, operation=create
+- `repo`: string; required; when resource=issue, operation=create
+- `title`: string; required; when resource=issue, operation=create
+- `body`: string; optional; when resource=issue, operation=create
+- `labels`: string; optional; when resource=issue, operation=create
+- `assignees`: string; optional; when resource=issue, operation=create
+- `owner`: string; required; when resource=issue, operation=list
+- `repo`: string; required; when resource=issue, operation=list
+- `state`: options; optional; when resource=issue, operation=list
+  - Values: `open`, `closed`, `all`
+- `limit`: number; required; when resource=issue, operation=list
+- `output`: options; optional; when resource=issue, operation=list
+  - Values: `simple`, `raw`, `fields`
+- `fields`: checkbox; required; when output=fields, resource=issue, operation=list
+  - Values: `id`, `number`, `title`, `state`, `body`, `user`, `labels`, `assignees`, `milestone`, `comments`, `locked`, `created_at`, `updated_at`, `closed_at`, `html_url`
+- `owner`: string; required; when resource=issue, operation=get
+- `repo`: string; required; when resource=issue, operation=get
+- `issueNumber`: number; required; when resource=issue, operation=get
+- `output`: options; optional; when resource=issue, operation=get
+  - Values: `simple`, `raw`, `fields`
+- `fields`: checkbox; required; when output=fields, resource=issue, operation=get
+  - Values: `id`, `number`, `title`, `state`, `body`, `user`, `labels`, `assignees`, `milestone`, `comments`, `locked`, `created_at`, `updated_at`, `closed_at`, `html_url`
+- `owner`: string; required; when resource=issue, operation=update
+- `repo`: string; required; when resource=issue, operation=update
+- `issueNumber`: number; required; when resource=issue, operation=update
+- `title`: string; optional; when resource=issue, operation=update
+- `body`: string; optional; when resource=issue, operation=update
+- `state`: options; optional; when resource=issue, operation=update
+  - Values: `noChange`, `open`, `closed`
+- `labels`: string; optional; when resource=issue, operation=update
+- `clearLabels`: boolean; optional; when resource=issue, operation=update
+- `assignees`: string; optional; when resource=issue, operation=update
+- `clearAssignees`: boolean; optional; when resource=issue, operation=update
+- `owner`: string; required; when resource=issue, operation=close
+- `repo`: string; required; when resource=issue, operation=close
+- `issueNumber`: number; required; when resource=issue, operation=close
+- `owner`: string; required; when resource=issue, operation=addLabels
+- `repo`: string; required; when resource=issue, operation=addLabels
+- `issueNumber`: number; required; when resource=issue, operation=addLabels
+- `labels`: string; required; when resource=issue, operation=addLabels
+- `owner`: string; required; when resource=issue, operation=createComment
+- `repo`: string; required; when resource=issue, operation=createComment
+- `issueNumber`: number; required; when resource=issue, operation=createComment
+- `body`: string; required; when resource=issue, operation=createComment
+- `owner`: string; required; when resource=repo, operation=getContents
+- `repo`: string; required; when resource=repo, operation=getContents
+- `path`: string; required; when resource=repo, operation=getContents
+- `ref`: string; optional; when resource=repo, operation=getContents
+- `isOrganization`: boolean; optional; when resource=repo, operation=create
+- `orgName`: string; required; when isOrganization=true, resource=repo, operation=create
+- `name`: string; required; when resource=repo, operation=create
+- `description`: string; optional; when resource=repo, operation=create
+- `private`: boolean; optional; when resource=repo, operation=create
+- `is_template`: boolean; optional; when resource=repo, operation=create
+- `owner`: string; required; when resource=gitBlob, operation=create
+- `repo`: string; required; when resource=gitBlob, operation=create
+- `content`: string; required; when resource=gitBlob, operation=create
+- `encoding`: options; optional; when resource=gitBlob, operation=create
+  - Values: `utf-8`, `base64`
+- `owner`: string; required; when resource=gitBlob, operation=get
+- `repo`: string; required; when resource=gitBlob, operation=get
+- `file_sha`: string; required; when resource=gitBlob, operation=get
+- `owner`: string; required; when resource=gitTree, operation=create
+- `repo`: string; required; when resource=gitTree, operation=create
+- `tree`: json; required; when resource=gitTree, operation=create
+- `base_tree`: string; optional; when resource=gitTree, operation=create
+- `owner`: string; required; when resource=gitTree, operation=get
+- `repo`: string; required; when resource=gitTree, operation=get
+- `tree_sha`: string; required; when resource=gitTree, operation=get
+- `recursive`: boolean; optional; when resource=gitTree, operation=get
+- `owner`: string; required; when resource=gitCommit, operation=create
+- `repo`: string; required; when resource=gitCommit, operation=create
+- `message`: string; required; when resource=gitCommit, operation=create
+- `tree`: string; required; when resource=gitCommit, operation=create
+- `parents`: string; required; when resource=gitCommit, operation=create
+- `owner`: string; required; when resource=commitStatus, operation=list
+- `repo`: string; required; when resource=commitStatus, operation=list
+- `ref`: string; required; when resource=commitStatus, operation=list
+- `limit`: number; required; when resource=commitStatus, operation=list
+- `output`: options; optional; when resource=commitStatus, operation=list
+  - Values: `simple`, `raw`, `fields`
+- `fields`: checkbox; required; when output=fields, resource=commitStatus, operation=list
+  - Values: `id`, `url`, `state`, `description`, `target_url`, `context`, `created_at`, `updated_at`, `creator`
+- `owner`: string; required; when resource=commitStatus, operation=create
+- `repo`: string; required; when resource=commitStatus, operation=create
+- `sha`: string; required; when resource=commitStatus, operation=create
+- `state`: options; required; when resource=commitStatus, operation=create
+  - Values: `error`, `failure`, `pending`, `success`
+- `target_url`: string; optional; when resource=commitStatus, operation=create
+- `description`: string; optional; when resource=commitStatus, operation=create
+- `context`: string; optional; when resource=commitStatus, operation=create
+- `owner`: string; required; when resource=commitStatus, operation=getCombined
+- `repo`: string; required; when resource=commitStatus, operation=getCombined
+- `ref`: string; required; when resource=commitStatus, operation=getCombined
+- `owner`: string; required; when resource=file, operation=createOrUpdate
+- `repo`: string; required; when resource=file, operation=createOrUpdate
+- `path`: string; required; when resource=file, operation=createOrUpdate
+- `message`: string; required; when resource=file, operation=createOrUpdate
+- `content`: string; required; when resource=file, operation=createOrUpdate
+- `sha`: string; optional; when resource=file, operation=createOrUpdate
+- `branch`: string; optional; when resource=file, operation=createOrUpdate
+- `owner`: string; required; when resource=action, operation=dispatch
+- `repo`: string; required; when resource=action, operation=dispatch
+- `workflowId`: string; required; when resource=action, operation=dispatch
+- `ref`: string; required; when resource=action, operation=dispatch
+- `inputs`: json; optional; when resource=action, operation=dispatch
+- `q`: string; required; when resource=search, operation=issuesAndPRs
+- `sort`: options; optional; when resource=search, operation=issuesAndPRs
+  - Values: `best-match`, `comments`, `reactions`, `created`, `updated`
+- `order`: options; optional; when resource=search, operation=issuesAndPRs
+  - Values: `desc`, `asc`
+- `pauseAfterExecution`: boolean; optional
+
+## Example
+
+```ts
+new Step({
+  id: 'github',
+  name: 'github',
+  type: 'github',
+  credentials: { name: 'github', id: 'credential-id' },
+  params: { /* use the required props and conditional values above */ },
+});
+```
+
+Further reading: [Culvii github node](https://culvii.com/docs/nodes/github/).