UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip codedapp

Commands for managing the full lifecycle of UiPath Coded Web Applications using the `uip codedapp` tool.

uip codedapp scaffolds, packs, publishes, deploys, and manages UiPath Coded Web Applications — HTML/JavaScript apps authored in Studio Web and hosted on UiPath Cloud. The verbs cover the full lifecycle: init a local starter, pull a remote project to local disk, push changes back, pack into a .nupkg, publish to UiPath, then deploy or upgrade the app. Install it with uip tools install codedapp, or invoke uip codedapp … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation. codedapp is the command prefix; the underlying package is @uipath/codedapp-tool.

The tool runs a pre-action hook on every command that reads the session written by uip login and exports it into the environment, so most auth-related flags are optional — they exist as one-off overrides. Only push/pull/publish/deploy (the verbs that talk to UiPath) accept these overrides; init and pack are purely local and register no auth flags at all.

Commands​

Every uip codedapp verb has its own reference page. For live argument lists on your installed tool version, run uip codedapp <verb> --help.

VerbDescription
initCreate a local coded app starter.
pushPush local source code to a Studio Web project.
pullPull project files from Studio Web to local disk.
packPackage a built coded app into a .nupkg.
publishPublish a .nupkg to UiPath and register the app.
deployDeploy or upgrade a published app in UiPath.

Synopsis​

uip codedapp init    <path> [--template <name>] [--type <Action>] [--force] [--skip-solution-registration]
uip codedapp pull    [--project-id <id>] [--target-dir <dir>] [--overwrite] [--verbose] [<auth flags>]
uip codedapp push    [--project-id <id>] [--build-dir <dir>] [--ignore-resources] [--version <v>] [--verbose] [<auth flags>]
uip codedapp pack    <dist> [--name <n>] [--version <v>] [--output-dir <dir>] [...]
uip codedapp publish [--name <n>] [--version <v>] [--type <Web|Action>] [--personal-workspace] [<auth flags>]
uip codedapp deploy  [--name <n>] [--version <v>] [--folder-key <key>] [<auth flags>]
uip codedapp init    <path> [--template <name>] [--type <Action>] [--force] [--skip-solution-registration]
uip codedapp pull    [--project-id <id>] [--target-dir <dir>] [--overwrite] [--verbose] [<auth flags>]
uip codedapp push    [--project-id <id>] [--build-dir <dir>] [--ignore-resources] [--version <v>] [--verbose] [<auth flags>]
uip codedapp pack    <dist> [--name <n>] [--version <v>] [--output-dir <dir>] [...]
uip codedapp publish [--name <n>] [--version <v>] [--type <Web|Action>] [--personal-workspace] [<auth flags>]
uip codedapp deploy  [--name <n>] [--version <v>] [--folder-key <key>] [<auth flags>]

Common auth-override flags on push/pull/publish/deploy: --base-url <url>, --org-id <id>, --tenant-id <id>, --access-token <token> (plus --org-name / --tenant-name where relevant). Prefer uip login — these flags are for one-off overrides. init and pack are local-only and take none of these.

All uip codedapp verbs honor the global options (--output, --output-filter, --log-level, --log-file). Standard exit codes apply.

See also​

  • Tools (plugins) — install model for @uipath/codedapp-tool.
  • uip login — credentials consumed by every subcommand.
  • Configuration — precedence of credentials (env vars → file → flags).
  • Commands​
  • Synopsis​
  • See also​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated