Skip to main content

File Update Intent Pseudo CLI

Generated from packages/codeboltjs/src/tools/pseudo-cli/commands.ts. Edit the registry or rerun node scripts/generate-pseudo-cli-docs.js instead of updating this file by hand.

The file-intent pseudo CLI module currently exposes 11 commands.

Related SDK docs: File Update Intent

Commands At A Glance

ActionDescriptionRequired flags
createCreate file update intent--data, --claimed-by
updateUpdate file update intent--id, --data
getGet file update intent--id
listList file update intentsNone
completeComplete file update intent--id, --closed-by
cancelCancel file update intent--id, --cancelled-by
check-overlapCheck for overlapping intents--env-id, --files
blocked-filesGet blocked files--env-id
by-agentGet intents by agent--agent-id
files-with-intentsGet files with active intents--env-id
deleteDelete file update intent--id

create

Create file update intent

codebolt file-intent create --data <json> --claimed-by <string> [--claimed-by-name <string>]
NameFlagTypeRequiredDescription
data--datajsonYesStructured JSON payload passed through to the underlying SDK method.
claimed-by--claimed-bystringYesValue for the claimed-by parameter.
claimed-by-name--claimed-by-namestringNoValue for the claimed-by-name parameter.

update

Update file update intent

codebolt file-intent update --id <string> --data <json>
NameFlagTypeRequiredDescription
id--idstringYesIdentifier of the target resource.
data--datajsonYesStructured JSON payload passed through to the underlying SDK method.

get

Get file update intent

codebolt file-intent get --id <string>
NameFlagTypeRequiredDescription
id--idstringYesIdentifier of the target resource.

list

List file update intents

codebolt file-intent list [--filters <json>]
NameFlagTypeRequiredDescription
filters--filtersjsonNoValue for the filters parameter.

complete

Complete file update intent

codebolt file-intent complete --id <string> --closed-by <string>
NameFlagTypeRequiredDescription
id--idstringYesIdentifier of the target resource.
closed-by--closed-bystringYesValue for the closed-by parameter.

cancel

Cancel file update intent

codebolt file-intent cancel --id <string> --cancelled-by <string>
NameFlagTypeRequiredDescription
id--idstringYesIdentifier of the target resource.
cancelled-by--cancelled-bystringYesValue for the cancelled-by parameter.

check-overlap

Check for overlapping intents

codebolt file-intent check-overlap --env-id <string> --files <json> [--priority <number>]
NameFlagTypeRequiredDescription
env-id--env-idstringYesValue for the env-id parameter.
files--filesjsonYesValue for the files parameter.
priority--prioritynumberNoPriority value for todo or task-related operations.

blocked-files

Get blocked files

codebolt file-intent blocked-files --env-id <string>
NameFlagTypeRequiredDescription
env-id--env-idstringYesValue for the env-id parameter.

by-agent

Get intents by agent

codebolt file-intent by-agent --agent-id <string>
NameFlagTypeRequiredDescription
agent-id--agent-idstringYesValue for the agent-id parameter.

files-with-intents

Get files with active intents

codebolt file-intent files-with-intents --env-id <string>
NameFlagTypeRequiredDescription
env-id--env-idstringYesValue for the env-id parameter.

delete

Delete file update intent

codebolt file-intent delete --id <string>
NameFlagTypeRequiredDescription
id--idstringYesIdentifier of the target resource.