Developer PowerShell

Developer PowerShell is a PowerShell profile that is optimized for development. It is a collection of scripts and configurations that are used to set up a development environment. The profile is designed to be used with the OctoMesh development environment.

Definitions and Concepts

Main Repositories: Most of the CoreService repositories including tools.
Branch Structure: OctoMesh supports branch-based development with a specific directory structure

Branch Directory Structure

The OctoMesh development environment uses a structured approach for managing branches:

/Users/gerald/RiderProjects/meshmakers/
├── main/                    # Main branch repositories
│   ├── octo-*/
│   ├── mm-*/
│   ├── nuget/       
│   └── Octo.user.props       
└── branches/                # Feature/development branches
    ├── feature-branch-1/    # Branch-specific repositories
    │   ├── octo-*/
    │   ├── mm-*/
    │   ├── nuget/    
    │   └── Octo.user.props            
    └── feature-branch-2/
        ├── octo-*/
        ├── mm-*/
        ├── nuget/      
        └── Octo.user.props                   

Branch Parameter: Many PowerShell commands support a -branch parameter to specify which branch directory to operate on:

Empty string or omitted: Operates directly on the root directory.
Main branch: When specifying main the scripts operates on the main/ directory.
Branch name: Operates on branch-specific directory (branches/{branch-name}/ directory)

Users

Here is a list of users that are needed for main services to connect to mongodb.

User	Default Password in dev environment	Comment
octo-system-admin	OctoAdmin1	User for creating tenants and configuration tenant independent
octo-system-ds-user-0	OctoUser1	User for the databases, 0 is the name of the database in MongoDB.

PowerShell Commands

Repository Management

Command	Description
Invoke-CloneMainRepos	Clones all main repositories to your root directory.
Sync-AllGitRepos	Pulls all repositories starting with `octo-` or `mm-`. Branch Parameter: `-branch` specifies branch directory (empty = main).
Sync-GitRepo	Pulls a repository from GitHub using the current directory by default or defining a parameter `repositoryPath`.
Push-GitRepo	Pushes a repository to GitHub using the current directory by default or defining a parameter `repositoryPath`.
Push-AllGitRepos	Pushes all repositories starting with `octo-`or `mm-`.
Get-AllGitRepStatus	Gets the status of all repositories starting with `octo-` and `mm-`. Branch Parameter: `-branch` specifies branch directory (empty = main).
Compare-BranchStatus	Compares current branch against origin/main for all `octo-` and `mm-` directories. Shows if commits are code changes, submodule updates, or merges. Use `-Details` for commit-level information.
Invoke-CleanAllGitRepos	Cleans all repositories starting with `octo-` and `mm-`. The `force` parameter is set to `false` by default.
Invoke-SwitchAllBranches	Switches all repositories to a specified branch. Branch Parameter: `-branch` specifies target branch directory.

Submodule Management

Command	Description
Sync-AllSubmodules	Pulls all submodules of all repositories starting with `octo-*`.
Sync-Submodule	Pulls all submodules of a repository from GitHub using the current directory by default or defining a parameter `repositoryPath`.

Build Management

Command	Description
Invoke-Build	Builds a repository for .NET using the current directory by default or defining a parameter `repositoryPath`.
Invoke-BuildAll	Builds all repositories starting with `octo-` and a solution file (`.sln`). Branch Parameter: `-branch` specifies branch directory (empty = main).
Invoke-Publish	Publishes the current directory by default or defining a parameter `repositoryPath`. Uses the `configuration` Release by default.
Invoke-BuildAndStartOcto	Builds all repositories and starts the main services.
Remove-BinAndObjFolders	Recursively deletes `bin` and `obj` folders within the specified `path`. Default path is `.`!

Service Management

Command	Description
Start-Octo	Starts the main services. See parameters below.
Stop-Octo	Stops services started in non-interactive mode (`Start-Octo -nonInteractive $true`) by writing a `.octo-stop` signal file. Branch Parameter: `-branch` specifies branch directory.

Start-Octo Parameters

Parameter	Type	Default	Description
`-branch`	String	`""`	Branch directory to operate on.
`-configuration`	String	`"Release"`	Build configuration (Release/Debug).
`-SystemDatabase`	String	`"OctoSystem"`	Name of the system database.
`-botService`	Boolean	`$true`	Start Bot Service.
`-identityService`	Boolean	`$true`	Start Identity Service.
`-assetRepoService`	Boolean	`$true`	Start Asset Repository Service.
`-meshAdapter`	Boolean	`$true`	Start Mesh Adapter.
`-meshAdapterTenantId`	String	`"meshtest"`	Tenant ID for the Mesh Adapter.
`-meshAdapterId`	String	`"66004fda527ac79a03ecedd7"`	Adapter runtime ID for the Mesh Adapter.
`-communicationControllerService`	Boolean	`$true`	Start Communication Controller Service.
`-platformServices`	Boolean	`$true`	Start Platform Services (the `_configuration` discovery service that replaced admin-panel).
`-reportingService`	Boolean	`$false`	Start Reporting Service.
`-simulationAdapter`	Boolean	`$false`	Start Simulation Adapter.
`-simulationAdapterTenantId`	String	`"meshtest"`	Tenant ID for the Simulation Adapter.
`-simulationAdapterId`	String	`"65d5c447b420da3fb12381bc"`	Adapter runtime ID for the Simulation Adapter.
`-identityOnly`	Boolean	`$false`	Start only Identity Service, ignores other service parameters.
`-identityAssetRepoOnly`	Boolean	`$false`	Start only Identity and Asset Repository Services.

Example with Mesh Adapter configuration:

Start-Octo -meshAdapterTenantId "mytenant" -meshAdapterId "abc123"

Example with Simulation Adapter:

Start-Octo -simulationAdapter $true -simulationAdapterTenantId "simtenant" -simulationAdapterId "def456"

Infrastructure Management

docker compose is deprecated

Kind (Install-OctoKubernetes) is the only supported local infrastructure. The docker compose commands below print a deprecation warning and will be removed on 2026-12-31. See Migrating from docker compose.

For further information on the infrastructure management and requirements please refer to the infrastructure documentation

Command	Description
Install-OctoKubernetes	Sets up the local kind cluster with MongoDB, CrateDB and RabbitMQ, the CRDs, ingress and the Communication Operator. The only supported local infrastructure. Safe to run again; upgrades an existing CrateDB without ever downgrading it.
Install-OctoInfrastructure	Deprecated (removal 2026-12-31). Uses the Docker Compose file located at infrastructure to compose the infrastructure dependencies.
Uninstall-OctoInfrastructure	Deprecated (removal 2026-12-31). Uninstalls the infrastructure dependencies by using the Docker Compose file at infrastructure.
Start-OctoInfrastructure	Deprecated (removal 2026-12-31). Starts the infrastructure dependencies by using the Docker Compose file at infrastructure.
Stop-OctoInfrastructure	Deprecated (removal 2026-12-31). Stops the infrastructure dependencies by using the Docker Compose file at infrastructure.
Get-OctoInfrastructureStatus	Deprecated (removal 2026-12-31). Gets the status of containers by using the Docker Compose file at infrastructure.
Invoke-KillDotnet	Windows only. Kills all dotnet processes. This is necessary to avoid file locks during build process.

NuGet Package Management

Command	Description
Copy-NuGetPackages	Finds NuGet packages for version `999.0.0` and copies them to `$NUGETPATH` using the current directory by default or defining a parameter `directory`. Branch Parameter: `-branch` specifies branch directory.
Copy-AllNugetPackages	Scans all `octo-` and `mm-` directories for NuGet packages for version `999.0.0` and copies them to `$NUGETPATH`.
Remove-GlobalNugetPackages	Removes in the global NuGet package folder (`$GLOBALNUGETPACKAGESPATH`) all MeshMaker NuGet packages in version `999.0.0`. Branch Parameter: `-branch` specifies branch directory.
Sync-NugetPackages	Copies, removes globally, and restores NuGet packages.

Branch Management

Command	Description
New-TestBranch	Creates a test branch for all `octo-` repositories with format `/test/0.x-description` and updates version in Directory.Build.props. Required Parameters: `-Version` (2-999), `-Description`. Optional*: `-NoPush` to skip pushing to remote.

CLI Management

Command Description

Register-OctoCliContext Unified context registration for any OctoMesh installation. Required Parameters: -Installation (the name of an entry in your octo-tools configuration's installations[] block — e.g. local) and -TenantId. Optional: -UriSuffix (substituted into the {0} placeholder in service URL templates, so a single entry can cover preview sub-environments), -IncludeReporting, -IncludeAi, -NoSwitch (don't switch active context), -NoLogin (skip interactive login). Replaces the former Invoke-OctoCliLogin{Local,Production,Staging,Test2} helpers.

Invoke-OctoCliReconfigureLogLevel Allows for reconfiguring of Log levels of Identity, AssetRepository, Bot and CommunicationController. Required Parameters: loggerName, minLogLevel and maxLogLevel

Command	Description
Register-OctoCliContext	Unified context registration for any OctoMesh installation. Required Parameters: `-Installation` (the name of an entry in your octo-tools configuration's `installations[]` block — e.g. `local`) and `-TenantId`. Optional: `-UriSuffix` (substituted into the `{0}` placeholder in service URL templates, so a single entry can cover preview sub-environments), `-IncludeReporting`, `-IncludeAi`, `-NoSwitch` (don't switch active context), `-NoLogin` (skip interactive login). Replaces the former `Invoke-OctoCliLogin{Local,Production,Staging,Test2}` helpers.
Invoke-OctoCliReconfigureLogLevel	Allows for reconfiguring of Log levels of Identity, AssetRepository, Bot and CommunicationController. Required Parameters: `loggerName`, `minLogLevel` and `maxLogLevel`

Infrastructure Backup & MongoDB Management

Deprecated

These backup commands only work on the docker compose volumes and will be removed on 2026-12-31 together with docker compose.

Backups operate on the infrastructure Docker volumes (MongoDB replica set and CrateDB cluster). The infrastructure must be stopped (Stop-OctoInfrastructure) before creating or restoring a backup; volumes are preserved. Backups are stored under infrastructure/backups/.

Command	Description
Backup-OctoInfrastructure	Deprecated (removal 2026-12-31). Creates a backup of all infrastructure Docker volumes (MongoDB + CrateDB). Optional Parameter: `-Name` (defaults to a `yyyyMMdd-HHmmss` timestamp).
Restore-OctoInfrastructure	Deprecated (removal 2026-12-31). Restores infrastructure Docker volumes from a named backup. Required Parameter: `-Name`. Run without `-Name` to list available backups.
Get-OctoInfrastructureBackup	Deprecated (removal 2026-12-31). Lists all available backups with volume count and total size.
Remove-OctoInfrastructureBackup	Deprecated (removal 2026-12-31). Deletes a named backup. Required Parameter: `-Name`. Optional: `-Force` to skip the confirmation prompt.
Invoke-MongoPortForward	Port-forwards the MongoDB service for direct database access (e.g. via a Mongo client).

Certificate Management

Command	Description
New-RootCertificate	Creates a new root certificate for development purposes.
New-ServerCertificate	Creates a new server certificate for development purposes.

Template Management

Command	Description
Sync-YamlTemplates	Synchronizes YAML templates across repositories.
Update-MeshmakerVersion	Updates MeshMaker version references across repositories.

Repository Discovery

Command	Description
Find-AllGitRepos	Finds all Git repositories in the current directory structure.

Additional Build Tools

Command	Description
Invoke-BuildZenonPlug	Builds the Zenon plug-in components.

Kubernetes Management

Command	Description
Join-KubeConfigs	Merges external Kubernetes configuration with existing `~/.kube/config` file. `externalKubeConfig` parameter can be configured.
Remove-KubeConfig	Removes Kubernetes configuration with required `name` parameter.

Branch Parameter Examples

Working with main branch (default behavior):

Sync-AllGitRepos -branch "main"     # Operates on main/ directory
Get-AllGitRepStatus -branch "main"   # Shows status for main branch repos
Invoke-BuildAll -configuration Release -branch "main" # Builds main branch

Working with feature branches:

Sync-AllGitRepos -branch "branches/mcp"           # Operates on branches/mcp/ directory
Get-AllGitRepStatus -branch "branches/feature-x"   # Shows status for feature-x branch repos
Invoke-BuildAll -branch "branches/dev" -configuration Debug  # Builds dev branch

Branch status comparison:

Compare-BranchStatus                    # Quick overview of all octo-*/mm-* repos
Compare-BranchStatus -Details           # Detailed view with individual commits

Creating test branches:

New-TestBranch -Version 5 -Description "feature-test"     # Creates a branch named /test/0.5-feature-test and pushes it to remote
New-TestBranch -Version 10 -Description "bugfix" -NoPush  # Creates branch locally only

Definitions and Concepts​

Branch Directory Structure​

Users​

PowerShell Commands​

Repository Management​

Submodule Management​

Build Management​

Service Management​

Start-Octo Parameters​

Infrastructure Management​

NuGet Package Management​

Branch Management​

CLI Management​

Infrastructure Backup & MongoDB Management​

Certificate Management​

Template Management​

Repository Discovery​

Additional Build Tools​

Kubernetes Management​

Branch Parameter Examples​