uipath-cli
latest
false
UiPath CLI user guide
- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip codedapp push
Syntax and options for `uip codedapp push`, which uploads local source to a Studio Web coded app project.
uip codedapp push uploads local source to a Studio Web project. It uploads the build output in --build-dir (default dist) and the project's source files from the project root, after an optional resource import. Use it to ship local edits back to a project that was originally pulled from Studio Web.
Synopsis
uip codedapp push [options]
uip codedapp push [options]
Options
| Flag | Description |
|---|---|
--project-id <id> | WebApp project ID. Reads from project metadata in the working directory if omitted. |
--build-dir <dir> | Build output directory. Default: dist. |
--ignore-resources | Skip importing referenced resources. |
--allow-large-files | Allow pushing files between 2 MB and 10 MB without a confirmation prompt. Required in non-interactive runs when any file is 2 MB or larger. |
-v, --version <version> | Set an explicit code version (for example, 2.0.0). |
--verbose | Show detailed progress logs. |
--base-url <url> | UiPath base URL (auth override). |
--org-id <id> | Organization ID (auth override). |
--tenant-id <id> | Tenant ID (auth override). |
--access-token <token> | Access token (auth override). |
Excluding files
push reads exclusion patterns from .gitignore and .uipignore in the project root. .uipignore uses the same syntax as .gitignore, and its patterns take precedence when the two files disagree. The following are always excluded, with or without an ignore file:
node_modules/and.uipath/.gitignore,.uipignore,.gitkeep.envfiles, including.env.local,.env.*.local,.env.development,.env.production,.env.test, and.env.example- Any other file or folder whose name starts with a dot
File checks
Before uploading, push checks every file it would send:
| Check | Result |
|---|---|
| File extension not in the allowed set of web-related types | Push blocked. The disallowed files are listed. |
| File of 10 MB or larger | Push blocked. |
| File of 2 MB or larger, below 10 MB | Interactive: confirmation prompt. Non-interactive: push blocked unless you pass --allow-large-files. |
action-schema.json present and invalid | Push blocked. |
Examples
# Push from the default ./dist build directory
uip codedapp push --project-id a1b2c3d4-0000-0000-0000-000000000001
# Custom build directory and explicit version
uip codedapp push --project-id a1b2c3d4-0000-0000-0000-000000000001 \
--build-dir build \
--version 2.0.0
# Push files between 2 MB and 10 MB without a prompt (CI)
uip codedapp push --project-id a1b2c3d4-0000-0000-0000-000000000001 --allow-large-files
# Skip resource imports
uip codedapp push --project-id a1b2c3d4-0000-0000-0000-000000000001 \
--ignore-resources
# Push from the default ./dist build directory
uip codedapp push --project-id a1b2c3d4-0000-0000-0000-000000000001
# Custom build directory and explicit version
uip codedapp push --project-id a1b2c3d4-0000-0000-0000-000000000001 \
--build-dir build \
--version 2.0.0
# Push files between 2 MB and 10 MB without a prompt (CI)
uip codedapp push --project-id a1b2c3d4-0000-0000-0000-000000000001 --allow-large-files
# Skip resource imports
uip codedapp push --project-id a1b2c3d4-0000-0000-0000-000000000001 \
--ignore-resources
Data shape (--output json)
{
"Code": "PushCompleted",
"Data": { "message": "Push completed successfully." }
}
{
"Code": "PushCompleted",
"Data": { "message": "Push completed successfully." }
}
A failed push returns Result: "Failure" with Message: "Push failed" and the cause in Instructions.
Related
- uip codedapp pull — fetch a remote project to local disk before editing.
- uip codedapp pack — package the build for publication once it's pushed.