Menu
Browse documentation

Commands & configuration

Use the right entry point for the package, and distinguish preview commands from writes.

Community entry point

Run install.ps1 or install.sh from the extracted Starter Kit 1.2.0 package. Core operations include new, enhance, upgrade, validate and rollback. Mutation plans should be reviewed with -DryRun before explicit -Approve. Existing-vault changes cannot be authorized by the answer file alone.

Use installation, upgrade and recovery for complete procedures. Do not add a global overwrite option.

Pro entry point

The recommended installation entry is:

pwsh -NoProfile -File ./Install-KOS.ps1 -Interactive

Do not add apply/license/planner overrides to that interactive invocation.

Pro project commands

Set $Vault to the installed vault. These examples use the default project role. Resolve a custom role before using a different workspace layout.

$Vault = 'D:\Vaults\KOS-Learning'
pwsh -NoProfile -File "$Vault/scripts/Get-KOSRolePaths.ps1" -Root $Vault -Role projects
pwsh -NoProfile -File "$Vault/scripts/Get-KOSContextManifest.ps1" -Project "02 - Projects/Active/Team workshop"
pwsh -NoProfile -File "$Vault/scripts/Search-KOS.ps1" -Query "project risk" -Path "02 - Projects"
Command Default behavior Write authorization
initialize-kos.ps1 Writes a scaffold Preview with -DryRun first; no -Apply switch exists
Manage-KOSProjectContext.ps1 Preview Activation requires -Confirm -Apply after review
Install-KOS.ps1 -Interactive Guided decisions Consent is collected in the flow

Configuration boundaries

Community setup answers select profile, timezone and providers. Pro’s guided inspection resolves supported role mappings. Do not hand-edit installer state, receipts or role authority to bypass a compatibility block. Keep secrets outside shared context files.

Preserved legacy command bindings

The approved October 19 Pro 1.1.0 installer can preserve five customized legacy interfaces during reviewed adoption. Only when the installer records the binding, use the Pro counterpart for Pro operations:

Preserved original Pro counterpart
scripts/Search-KOS.ps1 scripts/KOS-Pro-Search-KOS.ps1
scripts/Get-KOSContextManifest.ps1 scripts/KOS-Pro-Get-KOSContextManifest.ps1
scripts/Get-KOSChangedFiles.ps1 scripts/KOS-Pro-Get-KOSChangedFiles.ps1
scripts/Get-KOSChangelog.ps1 scripts/KOS-Pro-Get-KOSChangelog.ps1
scripts/validate-kos.ps1 scripts/KOS-Pro-validate-kos.ps1

Check the installer report before substituting paths. Fresh installations normally use the unprefixed commands shown elsewhere. Existing owner commands keep their original arguments and behavior; unsafe or colliding destinations block installation. Repeat planning retains the reviewed bindings, and rollback removes Pro additions without replacing the preserved originals.

Versions, sources & verification

Reviewed against: Starter Kit 1.2.0 / Community 1.0.0; KOS Pro 1.1.0 / Core 1.0.0.

Agent runtime behavior has not been tested for this article. Run the verification steps with your selected agent.

Source review confirms the documented interface. It does not replace testing your vault, tools, or recovery copy.