UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

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​

FlagDescription
--project-id <id>WebApp project ID. When omitted, read from the UIPATH_PROJECT_ID environment variable, then from UIPATH_PROJECT_ID in the .env file. Refer to Project ID.
--solution-name <name>Name of the Studio Web solution to create when no project ID is set. Goes with --project-name.
--project-name <name>Name of the coded app project to create in that solution when no project ID is set. Goes with --solution-name.
--build-dir <dir>Build output directory. Default: dist.
--ignore-resourcesSkip importing referenced resources.
--allow-large-filesAllow 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).
--verboseShow 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).

Project ID​

push uploads into an existing Studio Web project. It takes the project ID from the first of these that is set: --project-id, the UIPATH_PROJECT_ID environment variable, or UIPATH_PROJECT_ID in the .env file of the current directory.

When none is set, push creates a new Studio Web solution with a coded app project in it, and saves the new project ID as UIPATH_PROJECT_ID in .env, so the next push reuses it:

  • With --solution-name and --project-name, it creates the solution and project with those names, without prompting.
  • At an interactive terminal without them, it asks whether to create a new solution or use an existing one, and prompts for any missing name.
  • In a non-interactive run, both names are required. Without them, push fails and names the options to pass.

Passing --solution-name or --project-name while a project ID is set from any of the three sources is refused, so a push never goes to an existing project when you asked for a new one.

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
  • .env files, 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:

CheckResult
File extension not in the allowed set of web-related typesPush blocked. The disallowed files are listed.
File of 10 MB or largerPush blocked.
File of 2 MB or larger, below 10 MBInteractive: confirmation prompt. Non-interactive: push blocked unless you pass --allow-large-files.
action-schema.json present and invalidPush 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

# First push: create a new Studio Web solution and coded app project (CI)
uip codedapp push --solution-name "Finance Apps" --project-name "InvoiceViewer"

# 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

# First push: create a new Studio Web solution and coded app project (CI)
uip codedapp push --solution-name "Finance Apps" --project-name "InvoiceViewer"

# 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.

See also​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated