feat: generate .uiproj and studio_metadata files on init (#1450)

Author: radu-mocanu

packages/uipath-platform/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-platform"
-version = "0.0.27"
+version = "0.0.28"
 description = "HTTP client library for programmatic access to UiPath Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

packages/uipath-platform/src/uipath/platform/common/_config.py

@@ -130,6 +130,12 @@ def entry_points_file_path(self) -> Path:
 
         return Path(ENTRY_POINTS_FILE)
 
+    @property
+    def uiproj_file_path(self) -> Path:
+        from uipath.platform.common.constants import UIPROJ_FILE
+
+        return Path(UIPROJ_FILE)
+
     @property
     def studio_metadata_file_path(self) -> Path:
         from uipath.platform.common.constants import STUDIO_METADATA_FILE

packages/uipath-platform/src/uipath/platform/common/constants.py

@@ -78,6 +78,7 @@
 UIPATH_BINDINGS_FILE = "bindings.json"
 ENTRY_POINTS_FILE = "entry-points.json"
 STUDIO_METADATA_FILE = "studio_metadata.json"
+UIPROJ_FILE = "project.uiproj"
 
 
 # Folder names

packages/uipath-platform/uv.lock

@@ -40,9 +40,20 @@ Selected tenant: Tenant1
     :depth: 1
     :style: table
 
-Package requirements (bindings) are dependencies that are required by the automation package for successful execution.
+Initializes a UiPath project by generating all required configuration and metadata files. Run this command when setting up a new project and after modifying your agent's or function's input/output schema.
 
-For more information about package requirements, see  [the official documentation](https://docs.uipath.com/orchestrator/automation-cloud/latest/user-guide/managing-package-requirements)
+### Generated Files
+
+| File | Description |
+|------|-------------|
+| `uipath.json` | Project configuration with entrypoint definitions |
+| `bindings.json` | Resource bindings (assets, processes, buckets, etc.) |
+| `entry-points.json` | Entry point definitions with input/output schemas |
+| `project.uiproj` | Project metadata for StudioWeb integration |
+| `.uipath/studio_metadata.json` | Studio metadata (schema and code version) |
+| `.env` | Environment variables file |
+| `AGENTS.md`, `CLAUDE.md` | Agent documentation and coding assistant instructions |
+| `.agent/CLI_REFERENCE.md`, `.agent/SDK_REFERENCE.md`, `.agent/REQUIRED_STRUCTURE.md` | Agent reference docs |
 
 /// warning
 
@@ -63,7 +74,13 @@ Running `uipath init` will process these function definitions and create the cor
 ```shell
 > uipath init
 ⠋ Initializing UiPath project ...
-✓  Created 'entry-points.json' file.
+✓  Created 'uipath.json' file.
+✓  Created 'bindings.json' file.
+✓  Created 'entry-points.json' file with 1 entrypoint(s).
+✓  Created 1 mermaid diagram file(s).
+✓  Updated 'project.uiproj' file.
+✓  Created '.uipath/studio_metadata.json' file.
+✓  Created: CLAUDE.md, CLI_REFERENCE.md, SDK_REFERENCE.md, AGENTS.md, REQUIRED_STRUCTURE.md.
 ```
 ---
 

packages/uipath/docs/cli/index.md

@@ -1,13 +1,13 @@
 [project]
 name = "uipath"
-version = "2.10.18"
+version = "2.10.19"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"
 dependencies = [
   "uipath-core>=0.5.2, <0.6.0",
   "uipath-runtime>=0.9.1, <0.10.0",
-  "uipath-platform>=0.0.25, <0.1.0",
+  "uipath-platform>=0.0.28, <0.1.0",
   "click>=8.3.1",
   "httpx>=0.28.1",
   "pyjwt>=2.10.1",

packages/uipath/pyproject.toml

@@ -19,4 +19,9 @@ Entry point definitions with JSON Schema-based input/output contracts.
 
 - [Spec](entry-points.spec.md) | [Schema](entry-points.schema.json)
 
+### `project.uiproj` - Project Metadata
+Project-level metadata for StudioWeb integration. Auto-generated and auto-updated by `uipath init`.
+
+- [Spec](uiproj.spec.md) | [Schema](uiproj.schema.json)
+
 

packages/uipath/specs/README.md

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://cloud.uipath.com/draft/2024-12/uiproj",
+  "title": "UiPath Project Configuration",
+  "description": "Project-level metadata for UiPath coded automation projects, used by StudioWeb",
+  "type": "object",
+  "required": ["ProjectType", "Name", "MainFile"],
+  "properties": {
+    "ProjectType": {
+      "type": "string",
+      "description": "The type of project, determined from uipath.json entrypoints",
+      "enum": ["Agent", "Function"]
+    },
+    "Name": {
+      "type": "string",
+      "description": "Project name, sourced from pyproject.toml [project].name"
+    },
+    "Description": {
+      "type": ["string", "null"],
+      "description": "Project description, sourced from pyproject.toml [project].description"
+    },
+    "MainFile": {
+      "type": ["string", "null"],
+      "description": "Main file path. Required by StudioWeb but not used for coded agents",
+      "default": null
+    }
+  },
+  "additionalProperties": false
+}

packages/uipath/specs/uiproj.schema.json

@@ -0,0 +1,78 @@
+# UiPath Project Configuration Specification
+
+## Overview
+
+The `project.uiproj` file defines project-level metadata for UiPath coded projects. It is used by StudioWeb to identify the project type, name, and description. This file is auto-generated and auto-updated by `uipath init`.
+
+**File Name:** `project.uiproj`
+
+---
+
+## File Structure
+
+```json
+{
+  "ProjectType": "Agent",
+  "Name": "my-project",
+  "Description": "Project description",
+  "MainFile": null
+}
+```
+
+---
+
+## Properties
+
+| Property | Type | Required | Description |
+|----------|------|----------|-------------|
+| `ProjectType` | `string` | Yes | The type of project: `"Agent"` or `"Function"` |
+| `Name` | `string` | Yes | Project name, taken from `pyproject.toml` `[project].name` |
+| `Description` | `string\|null` | No | Project description, taken from `pyproject.toml` `[project].description` |
+| `MainFile` | `string\|null` | Yes | Main file path. Required by StudioWeb but not used for coded agents; always `null` for coded projects |
+
+---
+
+## ProjectType
+
+The `ProjectType` is determined automatically from the entrypoints defined in `uipath.json`:
+
+- **`"Agent"`** — when all entrypoints are declared under the `"agents"` key
+- **`"Function"`** — when at least one entrypoint is declared under the `"functions"` key, or when no entrypoints exist
+
+If `uipath.json` contains both `"agents"` and `"functions"` (mixed types), a warning is emitted and the type defaults to the first entrypoint's type.
+
+If the project type changes between runs of `uipath init` (e.g., an existing `project.uiproj` has `"Agent"` but the current entrypoints are all functions), a warning is displayed.
+
+---
+
+## Lifecycle
+
+- **Created by:** `uipath init` (when `project.uiproj` does not exist)
+- **Updated by:** `uipath init` (when `project.uiproj` already exists)
+- **Consumed by:** StudioWeb for project integration
+
+---
+
+## Complete Examples
+
+### Agent Project
+
+```json
+{
+  "ProjectType": "Agent",
+  "Name": "invoice-processor",
+  "Description": "An agent that processes invoices using DU",
+  "MainFile": null
+}
+```
+
+### Function Project
+
+```json
+{
+  "ProjectType": "Function",
+  "Name": "calculator",
+  "Description": "A simple calculator function",
+  "MainFile": null
+}
+```

packages/uipath/specs/uiproj.spec.md

@@ -443,6 +443,14 @@ def get_author_from_token_or_toml() -> str:
             with open(local_metadata_file, "r") as f:
                 metadata = json.load(f)
 
+        # ensure push-related fields are always present for cloud workspace
+        # context: on initial init the CLI creates a minimal studio_metadata.json file
+        # which does not contain lastPushAuthor and lastPushDate
+        if "lastPushAuthor" not in metadata:
+            metadata["lastPushAuthor"] = author
+        if "lastPushDate" not in metadata:
+            metadata["lastPushDate"] = datetime.now(timezone.utc).isoformat()
+
         existing = remote_files.get(".uipath/studio_metadata.json")
         if existing:
             try: