### Display Getting Started Link

Source: https://github.com/dotcms/core/blob/main/core-web/apps/dotcms-ui/src/app/view/components/dot-toolbar/components/dot-my-account/dot-my-account.component.html

Displays a link or text for 'starter.show.getting.started'.

```html
{{ 'starter.show.getting.started' | dm }}
```

--------------------------------

### Clone and Install Stencil Component Starter

Source: https://github.com/dotcms/core/blob/main/core-web/libs/dotcms-webcomponents/README.md

Clone the starter project, navigate into it, remove the default origin, install dependencies, and start the development server.

```bash
git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin
npm install
npm start
```

--------------------------------

### Complete Custom Field Example

Source: https://github.com/dotcms/core/blob/main/core-web/libs/edit-content-bridge/README.md

A practical example demonstrating initialization, getting a saved value, watching another field for changes, processing the change, and setting a new value for the current field. All logic is within the ready handler.

```javascript
DotCustomFieldApi.ready(() => {
    // 1. Initialize with saved value
    const savedValue = DotCustomFieldApi.get('myField');
    document.getElementById('displayValue').textContent = savedValue;

    // 2. Watch another field for changes
    DotCustomFieldApi.onChangeField('sourceField', (value) => {
        // Process the change
        const processed = processValue(value);

        // 3. Update our field
        DotCustomFieldApi.set('myField', processed);

        // Update display
        document.getElementById('displayValue').textContent = processed;
    });
});
```

--------------------------------

### GET /v1/example/{id}

Source: https://github.com/dotcms/core/blob/main/dotCMS/src/main/java/com/dotcms/rest/README.md

Retrieves a specific example resource by its unique identifier.

```APIDOC
## GET /v1/example/{id}

### Description
Retrieves a specific example resource by its unique identifier.

### Method
GET

### Endpoint
/v1/example/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Example identifier

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **ResponseEntityExampleView** (object) - Example retrieved successfully

#### Error Response
- **404** - Example not found
- **401** - Unauthorized access

#### Response Example
(Schema defined by ResponseEntityExampleView.class)
```

--------------------------------

### Display Help Examples

Source: https://github.com/dotcms/core/blob/main/core-web/libs/portlets/dot-es-search/src/lib/dot-es-search-page/dot-es-search-page.component.html

Iterates over help examples and displays their titles, descriptions, and queries.

```HTML
{{ 'esSearch.help.title' | dm }}

@for (example of helpExamples; track $index) {

{{ example.title | dm }}

@if (example.description) {

{{ example.description | dm }}

}

{{ example.query }}

}
```

--------------------------------

### Clone and Setup MCP Server

Source: https://github.com/dotcms/core/blob/main/core-web/apps/mcp-server/README.md

Steps to clone the dotCMS repository, install dependencies, and build the MCP server locally. No live dotCMS instance is required for this build.

```bash
# Clone the dotCMS repository
git clone https://github.com/dotcms/core.git
cd core/core-web

# Install dependencies
yarn install

# Build the server (spec.json is already committed — no live dotCMS instance needed)
yarn nx build mcp-server
```

--------------------------------

### Start DotCMS UI Development Server

Source: https://github.com/dotcms/core/blob/main/core-web/README.MD

Starts the development server for the dotcms-ui application. Includes proxy setup for the backend server.

```bash
nx serve dotcms-ui
```

--------------------------------

### Start Production Server

Source: https://github.com/dotcms/core/blob/main/examples/nextjs/CLAUDE.md

Command to start the application after it has been built for production.

```bash
# Start production server
npm start
```

--------------------------------

### Automatically Generate Custom Values File

Source: https://github.com/dotcms/core/blob/main/test-jmeter/README.md

The setup script automatically copies the example file and customizes it for your DotCMS host and current settings, creating `custom-values.yaml`.

```bash
# The script automatically copies the example file and customizes it for you
# Creates custom-values.yaml with your DotCMS host and current settings
./dotcms-analytics-test.sh setup --dotcms-host demo.dotcms.com

# Use a different values file name (also auto-generated)
./dotcms-analytics-test.sh setup --values-file production-values.yaml

# What happens automatically:
# 1. Copies custom-values.yaml.example → custom-values.yaml (or your filename)
# 2. Uncomments and sets your DotCMS host configuration
# 3. Sets useSecret: true for secure authentication
# 4. Includes all example configurations as comments for easy customization
```

--------------------------------

### Copy Example Tool

Source: https://github.com/dotcms/core/blob/main/core-web/apps/mcp-server/CONTRIBUTING.md

Use this command to copy the example tool structure to your new tool's directory.

```bash
cp -r src/tools/_example-tool src/tools/your-tool-name
```

--------------------------------

### Install Configured Tools

Source: https://github.com/dotcms/core/blob/main/.mise.md

Navigate to the dotCMS Core repository and run 'mise install' to install all configured tools. Alternatively, tools can auto-install upon entering the directory if enabled.

```bash
cd /path/to/dotcms/core
mise install
```

```bash
cd /path/to/dotcms/core
# Tools will install automatically if auto_install is enabled
```

--------------------------------

### Start dotCMS with Full Monitoring Stack (JMX + Debug + Glowroot)

Source: https://github.com/dotcms/core/blob/main/docs/infrastructure/DOCKER_BUILD_PROCESS.md

Enable JMX, Java debugging, and the Glowroot profiler for comprehensive monitoring. The 'just' command simplifies this setup.

```bash
# Enable JMX + Debug + Glowroot profiler
./mvnw -pl :dotcms-core -Pdocker-start,jmx-debug,glowroot -Djmx.debug.enable=true -Ddocker.glowroot.enabled=true

# Alternative using Just command  
just dev-run-jmx-debug-glowroot
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/react/CLAUDE.md

Install all project dependencies. This command should be run from the workspace root.

```bash
npm install
```

--------------------------------

### Site Start Command

Source: https://github.com/dotcms/core/blob/main/tools/dotcms-cli/cli/docs/site.adoc

Command to start a site.

```APIDOC
## site start

### Description

Use this command to start a site.

### Method

CLI Command

### Endpoint

N/A (CLI Command)

### Parameters

(Specific parameters for 'site start' are not detailed in the provided text.)

### Request Example

```bash
site start --help
```

### Response

(Success and error responses for 'site start' are not detailed in the provided text.)
```

--------------------------------

### Global Install and Run CLI

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/create-app/README.md

Install the CLI globally for easier access. Then, use the `create-dotcms-app` command to scaffold your project.

```sh
npm install -g @dotcms/create-app
create-dotcms-app my-app
```

--------------------------------

### Start Development Server with Turbopack

Source: https://github.com/dotcms/core/blob/main/examples/nextjs/CLAUDE.md

Use this command to start the development server with Turbopack for rapid development.

```bash
# Start development server with Turbopack
npm run dev
```

--------------------------------

### Install @dotcms/experiments via Yarn

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/experiments/README.md

Install the package using Yarn.

```bash
yarn add @dotcms/experiments
```

--------------------------------

### Create Next.js App with dotCMS Example

Source: https://github.com/dotcms/core/blob/main/starter/nextjs/README.md

Use this command to scaffold a new Next.js application pre-configured with the dotCMS example.

```bash
npx create-next-app YOUR_NAME --example https://github.com/dotcms/core/tree/main/starter/nextjs
```

--------------------------------

### Install @dotcms/experiments via npm

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/experiments/README.md

Install the package using npm.

```bash
npm install @dotcms/experiments
```

--------------------------------

### Start dotCMS Metrics Monitoring Stack

Source: https://github.com/dotcms/core/blob/main/docker/docker-compose-examples/single-node-metrics-monitoring/README.md

Use this command to clone the repository, navigate to the directory, and start all services for the monitoring stack.

```bash
# Clone the repository and navigate to this directory
cd docker/docker-compose-examples/single-node-metrics-monitoring

# Start all services
docker-compose up -d

# Check service status
docker-compose ps
```

--------------------------------

### Install Git using Homebrew

Source: https://github.com/dotcms/core/blob/main/dotBackendOnboarding.md

Installs Git, a version control system, using the Homebrew package manager.

```shell
brew install git
```

--------------------------------

### Show Help and Service Details

Source: https://github.com/dotcms/core/blob/main/docker/docker-compose-examples/experiments/README.md

Display help information and details about available services by running the start script with the --help flag.

```bash
# Show help and service details
./start-experiments.sh --help
```

--------------------------------

### Clone Vue Example Code

Source: https://github.com/dotcms/core/blob/main/examples/vuejs/README.md

Clone the dotCMS core repository and checkout the Vue.js example using sparse checkout. Ensure you have Git installed.

```bash
git clone -n --depth=1 --filter=tree:0 https://github.com/dotCMS/core
cd core
git sparse-checkout set --no-cone examples/vuejs
git checkout
```

--------------------------------

### Install dotCMS Utilities

Source: https://github.com/dotcms/core/blob/main/dotBackendOnboarding.md

Install the dotCMS Utilities collection using the provided curl command. This script automates the setup of internal tools for Git workflow.

```sh
curl -sSL https://raw.githubusercontent.com/dotCMS/dotcms-utilities/main/install.sh | bash
```

--------------------------------

### Deploy Starter ZIP Manually

Source: https://github.com/dotcms/core/blob/main/dotBackendOnboarding.md

Places a starter ZIP file into the target starter directory to be used on the next startup. Ensure the file is named 'starter.zip'.

```bash
core/dotCMS/target/starter/
```

--------------------------------

### Start New Environment with Fresh Starter

Source: https://github.com/dotcms/core/blob/main/docker/dev-env/README.md

Downloads and imports a clean starter.zip from the dotCMS artifactory repository. This is ideal for initializing a new development instance with a clean state.

```bash
docker run --rm \
--pull always \
-p 8443:8443 \
-v $PWD/data:/data \
-e DOTCMS_STARTER_URL=https://repo.dotcms.com/artifactory/libs-release-local/com/dotcms/starter/20250613/starter-20250613.zip \
dotcms/dotcms-dev:nightly
```

--------------------------------

### Install with Custom Values File

Source: https://github.com/dotcms/core/blob/main/test-jmeter/helm-chart/jmeter-performance/README.md

Install the JMeter Helm chart using a custom values file. It's recommended to copy the example file and modify your copy.

```bash
# ⚠️ IMPORTANT: Copy the example file - DO NOT edit the example directly
cp ../../custom-values.yaml.example my-values.yaml

# Edit your copy (NOT the .example file) with your specific configuration
# Edit my-values.yaml with your actual settings

# Install with custom values
helm install my-jmeter ./helm-chart/jmeter-performance -f my-values.yaml
```

--------------------------------

### HTTP GET Assertion Example

Source: https://github.com/dotcms/core/blob/main/core-web/apps/ai-evals/README.md

Verifies the state of dotCMS after a task run by making an authenticated GET request. Use to confirm model-driven changes. 'ok' checks for any 2xx status.

```yaml
- type: http_get
  path: /api/v1/folder/byPath/my-folder
  expect: ok

```

--------------------------------

### Copy Environment Example

Source: https://github.com/dotcms/core/blob/main/core-web/apps/ai-evals/README.md

Copy the example environment file to a new file for configuration. Ensure all required environment variables are set in the new file.

```bash
cp core-web/.env.example core-web/.env
```

--------------------------------

### Feature Branch Naming Convention Examples

Source: https://github.com/dotcms/core/blob/main/docs/core/GIT_WORKFLOWS.md

Examples of required feature branch naming conventions. Branches must start with 'issue-', followed by the GitHub issue number and a descriptive suffix separated by hyphens.

```bash
issue-32668-need-to-optimize-and-shrink-claudemd
```

```bash
issue-25620-alert-when-api-keys-about-to-expire
```

```bash
issue-32238-content-types
```

```bash
issue-32333-update-folder-ids
```

--------------------------------

### POST /v1/example

Source: https://github.com/dotcms/core/blob/main/dotCMS/src/main/java/com/dotcms/rest/README.md

Creates a new example resource with the provided data.

```APIDOC
## POST /v1/example

### Description
Creates a new example resource with the provided data.

### Method
POST

### Endpoint
/v1/example

### Parameters
#### Query Parameters
(None specified)

#### Request Body
- **ExampleForm** (object) - Required - Example data to create

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (201)
- **ResponseEntityExampleView** (object) - Example created successfully

#### Error Response
- **400** - Invalid request data
- **401** - Unauthorized access

#### Response Example
(Schema defined by ResponseEntityExampleView.class)
```

--------------------------------

### Download Starter Zip with Assets using wget

Source: https://github.com/dotcms/core/blob/main/docker/dev-env/README.md

This command downloads a starter zip file that includes assets. The oldAssets=false parameter helps to include only live and working versions of content.

```bash
wget --header="$AUTH_HEADER" -t 1 -O starter.zip $DOTCMS_SOURCE_ENVIRONMENT/api/v1/maintenance/_downloadStarterWithAssets?oldAssets=false
```

--------------------------------

### Start Elasticsearch and Kibana for Migration Testing

Source: https://github.com/dotcms/core/blob/main/docs/backend/OPENSEARCH_MIGRATION_TEST_PLAN.md

Use this command to start Elasticsearch and Kibana in detached mode for testing OpenSearch migration scenarios. Ensure your docker compose file is correctly configured for this setup.

```bash
docker compose -f docker/docker-compose-examples/os-migration/docker-compose.yml up -d elasticsearch kibana
```

--------------------------------

### Run dotCMS CLI Command

Source: https://github.com/dotcms/core/blob/main/core-web/apps/dotcms-ui/src/app/portlets/dot-starter/components/onboarding-dev/onboarding-dev.component.html

Execute this command to start dotCMS headless development using an interactive setup.

```bash
npx @dotcms/cli create my-project
```

--------------------------------

### Navigation Get Example

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/client/README.md

Fetches navigation items from the root URI with a specified depth to include child levels.

```typescript
const nav = await client.navigation.get('/', { depth: 2 });
```

--------------------------------

### Manual DotCMS Setup with Parameters

Source: https://github.com/dotcms/core/blob/main/test-jmeter/README.md

Configure the test environment manually by providing specific parameters for the DotCMS host, analytics host, and Kubernetes namespace during the setup command.

```bash
./dotcms-analytics-test.sh setup \
  --dotcms-host your-instance.dotcms.cloud \
  --analytics-host analytics.example.com \
  --namespace production-analytics
```

--------------------------------

### Get Page Content

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/client/README.md

Retrieve a specific page's content using the `client.page.get()` method. This example fetches the content for the '/about-us' page.

```typescript
const { pageAsset } = await client.page.get('/about-us');
```

--------------------------------

### Set Custom Starter URL

Source: https://github.com/dotcms/core/blob/main/docker/docker-compose-examples/single-node-debug-mode/README.md

Uncomment and modify this line to specify a custom starter zip URL. This allows for custom initial configurations.

```bash
#CUSTOM_STARTER_URL: 'https://repo.dotcms.com/artifactory/libs-release-local/com/dotcms/starter/20250722/starter-20250722.zip'
```

--------------------------------

### Production High Availability Setup for dotCMS

Source: https://github.com/dotcms/core/blob/main/docker/docker-compose-examples/lgtm-observability/README.md

Example Docker Compose configuration for a highly available dotCMS deployment with resource limits and a health check.

```yaml
services:
  dotcms:
    deploy:
      replicas: 3
      resources:
        limits:
          memory: 4G
          cpus: '2.0'
    healthcheck:
      test: ["CMD", "curl", "-f", "http://127.0.0.1:8090/dotmgt/livez"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 120s
```

--------------------------------

### Create Astro App with dotCMS Example

Source: https://github.com/dotcms/core/blob/main/examples/astro/README.md

Use this command to create a new Astro application pre-configured with the dotCMS example from a GitHub repository.

```bash
# Using npm
npm create astro@latest -- --template https://github.com/dotcms/core/tree/main/examples/astro
```

--------------------------------

### Specify Custom Starter URL

Source: https://github.com/dotcms/core/blob/main/docker/docker-compose-examples/single-node-demo-site/README.md

Set a custom starter URL to include a specific starter pack. Ensure the URL points to a valid .zip file.

```shell
CUSTOM_STARTER_URL: 'https://repo.dotcms.com/artifactory/libs-release-local/com/dotcms/xxxxxxxxxx.zip'
```

--------------------------------

### Instantiate and Start Dojo Application

Source: https://github.com/dotcms/core/blob/main/dotCMS/src/main/webapp/html/js/dojo/custom-build/dojox/app/README.txt

Use this code to instantiate and start a Dojo application by parsing a configuration object. It requires the dojox/json/ref and dojox/app/main modules, along with the application's configuration file.

```javascript
require(["dojox/json/ref", "dojox/app/main", "dojo/text!app/config.json"],function(json, Application, config){
		app = Application(json.parse(config));
	});
```

--------------------------------

### Cloudflare Tunnel Command Example

Source: https://github.com/dotcms/core/blob/main/core-web/libs/portlets/edit-ema/ui/src/lib/dot-page-scanner-report/dot-page-scanner-report.component.html

Use this command to start a Cloudflare tunnel, replacing '<your-local-url>' with your local URL. This is part of the steps to resolve private URL errors.

```bash
cloudflared tunnel --url <your-local-url>
```

--------------------------------

### Example .env file for Global Push Options

Source: https://github.com/dotcms/core/blob/main/tools/dotcms-cli/README.md

Specify additional options for the Global push command in the .env file. Use these options with caution as they can cause data loss.

```shell
DOT_CLI_OPTS="--force --dry-run"
```

```shell
DOT_CLI_OPTS=" --removeAssets --removeFolders --removeSites --removeContentTypes --removeLanguages --errors"
```

--------------------------------

### E2E Login Test Example

Source: https://github.com/dotcms/core/blob/main/docs/testing/E2E_TESTS.md

Concrete E2E test class demonstrating a successful login flow using the LoginPageSelenium Page Object. Extends BaseE2ETest for setup and teardown.

```java
public class LoginE2ETest extends BaseE2ETest {
    
    @Test
    public void testSuccessfulLogin() {
        LoginPageSelenium loginPage = new LoginPageSelenium(driver);
        
        loginPage.login("admin@dotcms.com", "admin");
        loginPage.waitForDashboard();
        
        assertTrue(driver.getCurrentUrl().contains("/dashboard"));
    }
}
```

--------------------------------

### site-start Command

Source: https://github.com/dotcms/core/blob/main/tools/dotcms-cli/cli/docs/site-start.adoc

This command is used to start a site, making it available for use. It's analogous to publishing a site.

```APIDOC
## site start

### Description
Use this command to start a site. Before a site can be used, it must be started first. You can think of this as a way to publish a site. Once a site is started, it is available for use. See the `site:stop` command.

### Method
CLI Command

### Endpoint
N/A (CLI Command)

### Parameters
#### Query Parameters
- **--dotcms-url** (string) - Required - The dotCMS URL to connect to. This option must be used along with the token option, which provides the token for the specified dotCMS URL.
- **-tk, --token** (string) - Required - A dotCMS token to use for authentication.

#### Path Parameters
- **idOrName** (string) - Required - Site name or Id.

### Request Example
```bash
site start --dotcms-url="http://localhost:8080" -tk="your_token" "YourSiteNameOrId"
```

### Response
#### Success Response (200)
N/A (CLI Command - output is typically text-based)

#### Response Example
(Output will vary based on success or failure, typically text messages indicating the status of the operation.)
```

--------------------------------

### Run dotCMS CLI in Dev Mode with Quarkus CLI

Source: https://github.com/dotcms/core/blob/main/tools/dotcms-cli/README.md

Execute this command from the 'cli' directory to start the dotCMS CLI in development mode using the Quarkus CLI. Ensure you have the Quarkus CLI installed.

```shell
quarkus dev
```

--------------------------------

### Example .dotcliignore file

Source: https://github.com/dotcms/core/blob/main/tools/dotcms-cli/README.md

Use this file to specify patterns for files and directories to be excluded during `files push` operations. Lines starting with '#' are comments, and blank lines are ignored. Patterns are relative to the workspace root.

```ignore
# Ignore all log files
*.log

# Ignore build directories
build/
dist/
target/

# Ignore OS-specific files
**/.DS_Store
**/Thumbs.db

# Ignore dependencies
node_modules/
vendor/

# Re-include a specific log file (negation)
!important.log
```

--------------------------------

### Interactive DotCMS Setup

Source: https://github.com/dotcms/core/blob/main/test-jmeter/README.md

Initiate the setup process interactively, where the script will prompt for necessary details such as the DotCMS host, username, password, and analytics key.

```bash
./dotcms-analytics-test.sh setup
```

--------------------------------

### Component Testing Setup with Spectator and Jest

Source: https://github.com/dotcms/core/blob/main/docs/frontend/TESTING_FRONTEND.md

Example of setting up a component test using Spectator with Jest. It demonstrates creating a component factory, mocking services, injecting dependencies, and interacting with the component via inputs and selectors.

```typescript
import { createComponentFactory, Spectator, byTestId } from '@ngneat/spectator/jest';
import { mockProvider } from '@ngneat/spectator/jest';
import { of, throwError } from 'rxjs';

describe('DotMyComponent', () => {
  let spectator: Spectator<DotMyComponent>;
  let mockService: SpyObject<MyService>;

  const createComponent = createComponentFactory({
    component: DotMyComponent,
    imports: [CommonModule, DotTestingModule],
    providers: [
      mockProvider(MyService, {
        getItems: jest.fn().mockReturnValue(of(mockItems)),
        saveItem: jest.fn().mockReturnValue(of(mockItem)),
        deleteItem: jest.fn().mockReturnValue(of(undefined))
      })
    ]
  });

  beforeEach(() => {
    spectator = createComponent();
    mockService = spectator.inject(MyService) as SpyObject<MyService>;
  });

  it('should show items when input is set', () => {
    spectator.setInput('config', mockConfig);
    spectator.detectChanges();
    expect(spectator.query(byTestId('items-list'))).toBeVisible();
  });
});
```

--------------------------------

### Start Migration Stack with Docker Compose

Source: https://github.com/dotcms/core/blob/main/docs/backend/OPENSEARCH_MIGRATION_TEST_PLAN.md

Launches the Elasticsearch, Kibana, OpenSearch, and OpenSearch Dashboards services for migration testing. Ensure this is run once to set up the environment.

```bash
docker compose -f docker/docker-compose-examples/os-migration/docker-compose.yml up -d
```

--------------------------------

### Use beforeEach and afterEach for Test Data Setup and Cleanup

Source: https://github.com/dotcms/core/blob/main/core-web/apps/dotcms-ui-e2e/README.md

This TypeScript example illustrates using `test.beforeEach` to create test data and `test.afterEach` to clean it up, ensuring that each test runs with isolated data. This pattern is crucial for maintaining test stability.

```typescript
test.describe('Content Management', () => {
    let testContent: Content;

    test.beforeEach(async ({ request }) => {
        // Create test data
        testContent = await createTestContent(request);
    });

    test.afterEach(async ({ request }) => {
        // Clean up test data
        await deleteContent(request, testContent.identifier);
    });

    test('should edit content', async ({ page }) => {
        // Use the created test data
        await page.goto(`/content/edit/${testContent.identifier}`);
    });
});
```

--------------------------------

### Configure Custom Starter URL

Source: https://github.com/dotcms/core/blob/main/docker/docker-compose-examples/cluster-mode/README.md

Uncomment and modify this line to specify a custom starter zip URL for dotCMS instances.

```dockerfile
#"CUSTOM_STARTER_URL": 'https://repo.dotcms.com/artifactory/libs-release-local/com/dotcms/starter/20250722/starter-20250722.zip'
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/dotcms/core/blob/main/docs/frontend/ANGULAR_STANDARDS.md

Installs project dependencies using Yarn. It is critical to use 'yarn install' and not 'npm install'.

```bash
yarn install
```

--------------------------------

### Install Mise

Source: https://github.com/dotcms/core/blob/main/.mise.md

Install Mise on macOS using Homebrew or via the official installer script.

```bash
# macOS
brew install mise
```

```bash
# Or using the official installer
curl https://mise.run | sh
```

--------------------------------

### Install Homebrew Package Manager

Source: https://github.com/dotcms/core/blob/main/dotBackendOnboarding.md

Installs Homebrew, a package manager for macOS, to simplify software installation.

```shell
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Install dotCMS CLI using NPM

Source: https://github.com/dotcms/core/blob/main/tools/dotcms-cli/README.md

Install the dotCMS CLI globally using npm. This is the recommended installation method.

```shell
npm install -g @dotcms/dotcli
```

--------------------------------

### Install Java and Node.js Versions

Source: https://github.com/dotcms/core/blob/main/CLAUDE.md

Use SDKMAN to install the required Java version and nvm to manage Node.js versions. Building with incorrect versions will cause failures.

```bash
sdk env install   # Java 25 via SDKMAN (.sdkmanrc) — build fails with wrong version
nvm use           # Node 22.15+ via nvm (.nvmrc) — frontend build fails with wrong version
```

--------------------------------

### Clone dotCMS Environment using Starter Functionality

Source: https://github.com/dotcms/core/blob/main/docker/dev-env/README.md

Clones a dotCMS environment by requesting the source server to generate a starter.zip. This method can be time-consuming for both generation and initial import.

```bash
docker run --rm \
--pull always \
-p 8443:8443 \
-v $PWD/data:/data \
-e DOTCMS_SOURCE_ENVIRONMENT=https://demo.dotcms.com \
-e DOTCMS_USERNAME_PASSWORD="admin@dotcms.com:admin" \
-e DOTCMS_CLONE_TYPE=starter \
dotcms/dotcms-dev:nightly
```

--------------------------------

### Verify Node.js and npm Installation

Source: https://github.com/dotcms/core/blob/main/dotcms-postman/src/main/resources/postman/Readme.md

Check if Node.js and npm are installed correctly by displaying their versions. This is a verification step after installation.

```bash
node -v
npm -v
```

--------------------------------

### Optional Custom Starter URL

Source: https://github.com/dotcms/core/blob/main/docker/docker-compose-examples/load-db-dump/README.md

Uncomment and update this line to specify a custom starter zip file. This is typically not needed when loading from a database dump.

```yaml
CUSTOM_STARTER_URL: 'https://repo.dotcms.com/artifactory/libs-release-local/com/dotcms/starter/20260409/starter-20260409.zip'
```

--------------------------------

### Install Project Dependencies with Yarn

Source: https://github.com/dotcms/core/blob/main/e2e/dotcms-e2e-node/README.md

Installs project dependencies using Yarn. Ensure Node, NPM, and Yarn are installed beforehand.

```shell
yarn install --frozen-lockfile
```

--------------------------------

### Check GraalVM Installation

Source: https://github.com/dotcms/core/blob/main/docs/cli/CLI_BUILD_SYSTEM.md

Verify if GraalVM is installed and accessible by checking its version. Native image builds require a compatible GraalVM installation.

```bash
java -version
```

--------------------------------

### Full Build with No Tests

Source: https://github.com/dotcms/core/blob/main/docs/infrastructure/DOCKER_BUILD_PROCESS.md

Performs a clean installation of the project, skipping all tests. This is recommended for the initial build or after major changes.

```bash
./mvnw clean install -DskipTests
```

```bash
just build
```

--------------------------------

### Create User-Specific Configuration File

Source: https://github.com/dotcms/core/blob/main/docs/infrastructure/DOCKER_BUILD_PROCESS.md

Copy the example user configuration file and edit it with your specific settings. This allows for environment-specific overrides without modifying base configuration files.

```bash
# Copy example file
cp environments/dev/user-dev.properties.example environments/dev/user-dev.properties

# Edit with your specific settings
vim environments/dev/user-dev.properties
```

--------------------------------

### Install Newman Globally via npm

Source: https://github.com/dotcms/core/blob/main/dotcms-postman/src/main/resources/postman/Readme.md

Install the Newman CLI for running Postman collections from the command line. This command installs Newman globally.

```bash
npm install -g newman
```

--------------------------------

### Start Docker Compose Stack

Source: https://github.com/dotcms/core/blob/main/docker/docker-compose-examples/single-node-os-migration/README.md

Use this command to bring up all services defined in the docker-compose.yml file.

```bash
docker compose up -d
```

--------------------------------

### Install dotCMS Angular SDK

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/angular/README.md

Install the latest version of the dotCMS Angular SDK using npm. This command also installs necessary dependencies like @dotcms/uve and @dotcms/client.

```bash
npm install @dotcms/angular@latest
```

--------------------------------

### initUVE()

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/uve/README.md

Initializes the UVE SDK with the provided configuration. This is a foundational step for enabling live editing features.

```APIDOC
## initUVE()

### Description
Initializes the UVE SDK with the provided configuration object.

### Method
`initUVE(config: DotCmsUveConfig)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **config** (DotCmsUveConfig) - Required - The configuration object for UVE.

### Request Example
```javascript
import { initUVE } from '@dotcms/uve';

const uveConfig = {
  // ... configuration properties
};

initUVE(uveConfig);
```

### Response
None
```

--------------------------------

### Install dotCMS React SDK

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/react/README.md

Install the latest version of the dotCMS React SDK using npm. This command also installs necessary dependencies like @dotcms/uve and @dotcms/client.

```bash
npm install @dotcms/react@latest
```

--------------------------------

### Build the SDK React Library

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/react/CLAUDE.md

Use this command to build the SDK React library. Ensure you are in the workspace root.

```bash
nx build sdk-react
```

--------------------------------

### Install @dotcms/types

Source: https://github.com/dotcms/core/blob/main/core-web/libs/sdk/types/README.md

Install the @dotcms/types package as a development dependency using npm.

```bash
npm install @dotcms/types@latest --save-dev
```

--------------------------------

### Install Dependencies with Yarn

Source: https://github.com/dotcms/core/blob/main/core-web/README.MD

Run this command to install all project dependencies for the monorepo.

```bash
yarn install
```