@alneas/eaos-cli API

Public entrypoints

Import	Contract
`@alneas/eaos-cli/commands/deployment`	Typed public export
`@alneas/eaos-cli/commands/lifecycle`	Typed public export
`@alneas/eaos-cli/commands/plugin`	Typed public export
`@alneas/eaos-cli/commands/sync-routes`	Typed public export
`@alneas/eaos-cli`	Typed public export
`@alneas/eaos-cli/platform/deploy`	Typed public export
`@alneas/eaos-cli/platform/deployment-placement-config`	Typed public export
`@alneas/eaos-cli/platform/deployment-plan`	Typed public export
`@alneas/eaos-cli/platform/deployment-status`	Typed public export
`@alneas/eaos-cli/platform`	Typed public export
`@alneas/eaos-cli/platform/kamal-secrets`	Typed public export
`@alneas/eaos-cli/platform/kamal`	Typed public export
`@alneas/eaos-cli/platform/packages`	Typed public export
`@alneas/eaos-cli/platform/render`	Typed public export
`@alneas/eaos-cli/plugin-tools/commands/check-contracts`	Typed public export
`@alneas/eaos-cli/plugin-tools/commands/detect-secrets`	Typed public export
`@alneas/eaos-cli/plugin-tools/commands/diagnose-plugin`	Typed public export
`@alneas/eaos-cli/plugin-tools/commands/generate-mcp-tools`	Typed public export
`@alneas/eaos-cli/plugin-tools/commands/generate-plugin`	Typed public export
`@alneas/eaos-cli/plugin-tools/commands/infer-contracts`	Typed public export
`@alneas/eaos-cli/plugin-tools/commands/sync-agents-md`	Typed public export
`@alneas/eaos-cli/plugin-tools`	Typed public export
`@alneas/eaos-cli/plugin-tools/inspect`	Typed public export
`@alneas/eaos-cli/plugin-tools/utils`	Typed public export
`@alneas/eaos-cli/site`	Typed public export
`@alneas/eaos-cli/version`	Typed public export
`@alneas/eaos-cli/baseline`	Typed public export
`@alneas/eaos-cli/dev`	Typed public export
`@alneas/eaos-cli/commands/architecture`	Typed public export
`@alneas/eaos-cli/presets/oci-adb`	Typed public export
`@alneas/eaos-cli/presets/oci-adb/infra`	Typed public export
`@alneas/eaos-cli/presets/oci-adb/infra/access`	Typed public export
`@alneas/eaos-cli/presets/oci-adb/infra/database`	Typed public export
`@alneas/eaos-cli/presets/oci-adb/infra/vault`	Typed public export
`@alneas/eaos-cli/presets/oci-adb/infra/lookups`	Typed public export
`@alneas/eaos-cli/platform/preset`	Typed public export
`@alneas/eaos-cli/platform/operations`	Typed public export
`@alneas/eaos-cli/presets/oci-adb/template`	Typed public export
`@alneas/eaos-cli/platform/deployment-assets`	Typed public export

[INTERFACE] `AdbConnectionProfile`

Provider-supplied ADB connection profile fields used for deterministic DSN selection.

Imports: @alneas/eaos-cli/presets/oci-adb/infra/database.

Signature

interface AdbConnectionProfile {
    consumerGroup: string;
    tlsAuthentication: string;
    protocol: string;
    hostFormat: string;
    syntaxFormat: string;
    sessionMode?: string;
    isRegional?: boolean;
    displayName?: string;
    value: string;
}

Parameters

Name	Type	Required	Description
`consumerGroup`	`string`	Yes	Provider workload-group label compared against the selected consumerGroup filter.
`tlsAuthentication`	`string`	Yes	Provider TLS-authentication label compared against the selected tlsAuthentication filter.
`protocol`	`string`	Yes	Provider connection protocol; DSN selection requires TCPS.
`hostFormat`	`string`	Yes	Provider hostname representation compared against the selected hostFormat filter.
`syntaxFormat`	`string`	Yes	Provider DSN syntax label compared against the selected syntaxFormat filter.
`sessionMode`	`string`	No	Optional provider DIRECT/REDIRECT session mode; checked only when selection.sessionMode is supplied.
`isRegional`	`boolean`	No	Optional provider regional-profile flag; checked only when selection.isRegional is supplied.
`displayName`	`string`	No	Optional provider display name; compared exactly only when selection.displayName is supplied.
`value`	`string`	Yes	Provider-supplied connection string; selection requires exactly one nonblank match and never rewrites it.

Returns

Type declaration; no runtime value.

Public members

`consumerGroup`

Provider workload-group label compared against the selected consumerGroup filter.

`tlsAuthentication`

Provider TLS-authentication label compared against the selected tlsAuthentication filter.

`protocol`

Provider connection protocol; DSN selection requires TCPS.

`hostFormat`

Provider hostname representation compared against the selected hostFormat filter.

`syntaxFormat`

Provider DSN syntax label compared against the selected syntaxFormat filter.

`sessionMode`

Optional provider DIRECT/REDIRECT session mode; checked only when selection.sessionMode is supplied.

`isRegional`

Optional provider regional-profile flag; checked only when selection.isRegional is supplied.

`displayName`

Optional provider display name; compared exactly only when selection.displayName is supplied.

`value`

Provider-supplied connection string; selection requires exactly one nonblank match and never rewrites it.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `agentDocumentNext`

Replace one well-formed generated block while preserving surrounding human-authored text.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/sync-agents-md.

Signature

declare function agentDocumentNext(existing: string, block: string): string;

Parameters

Name	Type	Required	Description
`existing`	`string`	Yes	Current document text, possibly without a generated block.
`block`	`string`	Yes	Replacement generated block, normally from renderAgentMetadata.

Returns

string

Updated document text; a missing block is appended.

Remarks

The replacement block itself is trusted and is not parsed for marker validity.

Errors and rejections

If existing markers are mismatched, repeated or reversed.

Example

import { agentDocumentNext } from '@alneas/eaos-cli/plugin-tools'
const next = agentDocumentNext('# Notes', '<!-- eaos:generated:start -->\nContract\n<!-- eaos:generated:end -->')

[FUNCTION] `assertPluginId`

Reject identifiers outside the lowercase hyphen-separated plugin naming grammar.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/utils.

Signature

declare function assertPluginId(id: string): void;

Parameters

Name	Type	Required	Description
`id`	`string`	Yes	Identifier beginning with a lowercase letter; segments contain lowercase letters or digits.

Returns

void

No value; normal completion means the identifier matches the naming grammar.

Errors and rejections

If the identifier does not match the required grammar.

Example

import { assertPluginId } from '@alneas/eaos-cli/plugin-tools'
assertPluginId('notes-api')

[CONSTANT] `baselineImages`

Checksum-pinned PostgreSQL and Oracle Docker images used by local schema-baseline compilation; acquisition is a separate operator step.

Imports: @alneas/eaos-cli/baseline.

Signature

declare const baselineImages: {
    readonly postgres: "postgres@sha256:c7526c0f6c3f30260a563d7bcf8ad778effac59a44f8ffa86678c35418338609";
    readonly oracle: "gvenzl/oracle-free@sha256:6d61d267a3b978c24c5ac1790e62e927416a0aec446bd86e4b3a1527562757bd";
};

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `callSiteControl`

Call an allowlisted site-control route using the registered endpoint and environment-bound token.

Imports: @alneas/eaos-cli/site.

Signature

declare function callSiteControl(config: SiteOperationsConfig, id: string, path: string, input?: unknown): Promise<any>;

Parameters

Name	Type	Required	Description
`config`	`SiteOperationsConfig`	Yes	Validated site catalog with the remote API binding.
`id`	`string`	Yes	Registered site identifier; site-specific request paths must select this same ID.
`path`	`string`	Yes	Allowed /sites or site request/run path, never an arbitrary remote URL.
`input`	`unknown`	No	Optional JSON request body; omitted input uses GET, otherwise POST.

Returns

Promise<any>

The parsed JSON response from the registered control endpoint.

Remarks

POST may change host state; remote authorization and command semantics remain owned by the control service. No automatic retry is performed.

Errors and rejections

Rejects missing auth bindings, forbidden paths, redirects/network timeout (30 seconds), non-2xx responses, responses over 1 MiB or invalid JSON.

Example

import { callSiteControl } from '@alneas/eaos-cli/site'
export function listSites(config: Parameters<typeof callSiteControl>[0], id: string) { return callSiteControl(config, id, '/sites') }

[FUNCTION] `checkContracts`

Compare statically inspected plugin contracts against a workspace-owned baseline.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/check-contracts.

Signature

declare function checkContracts(root: string, options: ContractCheckOptions): Promise<void>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted workspace root containing the plugin and baseline.
`options`	`ContractCheckOptions`	Yes	Required plugin and against path; against must identify a regular workspace file.

Returns

Promise<void>

Resolves without a value when the baseline is compatible; additions are reported to stdout.

Remarks

Does not import plugin code; checks metadata compatibility rather than runtime authorization or complete semantic equivalence.

Errors and rejections

Rejects unresolved contracts, mismatched plugin identities, incompatible schemas/policies or an invalid baseline.

Example

import { checkContracts } from '@alneas/eaos-cli/plugin-tools'
export async function checkNotes(root: string) { await checkContracts(root, { plugin: 'notes', against: 'contracts/notes.json' }) }

[FUNCTION] `checkLocalSite`

Resolve registered local site/Bun paths and verify the named package scripts are declared.

Imports: @alneas/eaos-cli/site.

Signature

declare function checkLocalSite(config: SiteOperationsConfig, id: string): Promise<{
    site: LocalSiteProfile;
    directory: string;
    executable: string;
    buildScript: string;
    previewScript: string;
    packageHash: string;
}>;

Parameters

Name	Type	Required	Description
`config`	`SiteOperationsConfig`	Yes	Validated site catalog with a Bun path and local directory.
`id`	`string`	Yes	Exact registered site identifier.

Returns

Promise<{ site: LocalSiteProfile; directory: string; executable: string; buildScript: string; previewScript: string; packageHash: string; }>

Real directory/executable paths, selected build/preview scripts and the package manifest hash.

Remarks

Resolves the executable path but does not check its file type or execution permissions. It does not execute scripts or verify their safety; their contents are trusted project code.

Errors and rejections

Rejects unknown/missing local bindings, absent package scripts or filesystem/JSON errors.

Example

import { checkLocalSite } from '@alneas/eaos-cli/site'
export function inspectSite(config: Parameters<typeof checkLocalSite>[0], id: string) { return checkLocalSite(config, id) }

[CONSTANT] `cliVersion`

CLI release version injected by the build, falling back to the source package version when running source.

Imports: @alneas/eaos-cli/version.

Signature

declare const cliVersion: string;

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `CommandOptions`

Command-specific plugin authoring arguments; each command validates the subset it consumes.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/utils.

Signature

interface CommandOptions {
    plugin?: string;
    check?: boolean;
    write?: boolean;
    autoFix?: boolean;
    name?: string;
    description?: string;
    industry?: string;
    tier?: string;
    addonId?: string;
    monthlyQuota?: string;
    allowedTenants?: string;
    targets?: string;
    features?: string;
    output?: string;
    format?: string;
    against?: string;
}

Parameters

Name	Type	Required	Description
`plugin`	`string`	No	Existing plugin ID consumed by inspection/maintenance commands.
`check`	`boolean`	No	Read-only equality/diagnostic verification where supported; failures reject.
`write`	`boolean`	No	Explicit permission to replace an existing generated draft where supported.
`autoFix`	`boolean`	No	Command-specific guidance flag; secret detection does not rewrite matched content.
`name`	`string`	No	New plugin name used to derive a validated identifier.
`description`	`string`	No	Human-readable plugin description written into generated metadata.
`industry`	`string`	No	Optional author-selected industry label for generated metadata.
`tier`	`string`	No	Public, standard, pro or corporate policy selection; supported legacy aliases are normalized by the generator.
`addonId`	`string`	No	Explicit Pro addon identity; generator otherwise derives its default from the plugin ID.
`monthlyQuota`	`string`	No	Text form of the nonnegative admitted-request budget; zero grants no metered calls.
`allowedTenants`	`string`	No	Comma-separated explicit Corporate tenant allowlist; Corporate generation requires it.
`targets`	`string`	No	Command-specific selected client/runtime target hints.
`features`	`string`	No	Command-specific optional generated feature hints.
`output`	`string`	No	Optional new scaffold destination, subject to the generator’s path and existence checks.
`format`	`string`	No	Diagnostic format; json requests structured source inspection.
`against`	`string`	No	Workspace-relative contract-baseline JSON used for compatibility checks.

Returns

Type declaration; no runtime value.

Public members

`plugin`

Existing plugin ID consumed by inspection/maintenance commands.

`check`

Read-only equality/diagnostic verification where supported; failures reject.

`write`

Explicit permission to replace an existing generated draft where supported.

`autoFix`

Command-specific guidance flag; secret detection does not rewrite matched content.

`name`

New plugin name used to derive a validated identifier.

`description`

Human-readable plugin description written into generated metadata.

`industry`

Optional author-selected industry label for generated metadata.

`tier`

Public, standard, pro or corporate policy selection; supported legacy aliases are normalized by the generator.

`addonId`

Explicit Pro addon identity; generator otherwise derives its default from the plugin ID.

`monthlyQuota`

Text form of the nonnegative admitted-request budget; zero grants no metered calls.

`allowedTenants`

Comma-separated explicit Corporate tenant allowlist; Corporate generation requires it.

`targets`

Command-specific selected client/runtime target hints.

`features`

Command-specific optional generated feature hints.

`output`

Optional new scaffold destination, subject to the generator’s path and existence checks.

`format`

Diagnostic format; json requests structured source inspection.

`against`

Workspace-relative contract-baseline JSON used for compatibility checks.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `ContractCheckOptions`

Plugin selection and workspace-relative baseline for static compatibility checking.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/check-contracts.

Signature

interface ContractCheckOptions extends CommandOptions {
    against?: string;
}

Parameters

Name	Type	Required	Description
`against`	`string`	No	Required workspace-relative regular JSON file containing the previously inspected contract.

Returns

Type declaration; no runtime value.

Public members

`against`

Required workspace-relative regular JSON file containing the previously inspected contract.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `createDeploymentPlan`

Validate inventories and every declared asset hash without executing deployment or migrations.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/deployment-plan.

Signature

declare function createDeploymentPlan(paths: string[], options?: {
    placements?: DeploymentPlacements;
}): Promise<{
    databasePolicy: string;
    componentPlacements?: {
        owner: string;
        pluginId: string;
        componentId: string;
        destinationIds: string[];
        adopted: boolean;
    }[] | undefined;
    destinations?: _alneas_eaos_server_platform.DeploymentDestination[] | undefined;
    mode: string;
    contributions: DeploymentContribution[];
}>;

Parameters

Name	Type	Required	Description
`paths`	`string[]`	Yes	Deployment inventory JSON paths; each must be a regular nonsymlink file of at most 1 MiB.
`options`	`{ placements?: DeploymentPlacements; }`	No	Optional explicit placement catalog for component-to-destination resolution.

Returns

Promise<{ databasePolicy: string; componentPlacements?: { owner: string; pluginId: string; componentId: string; destinationIds: string[]; adopted: boolean; }[] \| undefined; destinations?: _alneas_eaos_server_platform.DeploymentDestination[] \| undefined; mode: string; contributions: DeploymentContribution[]; }>

Verified contributions, function bindings and any resolved placement plan.

Remarks

Reads packaged sources but does not certify their behavior or authorize host adoption.

Errors and rejections

Rejects malformed or duplicate owners/assets/functions, path escapes, symlinks, checksum mismatches and unresolved required placements.

Public members

`options.placements`

Optional explicit component/destination selections to validate against the verified inventories; omitted performs artifact-only inspection.

Example

import { createDeploymentPlan } from '@alneas/eaos-cli/platform'
export function inspectInventory(path: string) { return createDeploymentPlan([path]) }

[FUNCTION] `createOciAdbPreset`

Declare the OCI edge/worker network, ADB, private object storage and KMS resources for a trusted host stack.

Imports: @alneas/eaos-cli/presets/oci-adb.

Signature

declare function createOciAdbPreset(name: string, args: OciAdbPresetArgs, options?: pulumi.CustomResourceOptions): {
    network: {
        vcn: _pulumi_oci_core_vcn.Vcn;
        dhcpOptions: _pulumi_oci_core_dhcpOptions.DhcpOptions;
        internetGateway: _pulumi_oci_core_internetGateway.InternetGateway;
        natGateway: _pulumi_oci_core_natGateway.NatGateway;
        serviceGateway: _pulumi_oci_core_serviceGateway.ServiceGateway | undefined;
        publicRoutes: _pulumi_oci_core_routeTable.RouteTable;
        privateRoutes: _pulumi_oci_core_routeTable.RouteTable;
        publicSecurityList: _pulumi_oci_core_securityList.SecurityList;
        privateSecurityList: _pulumi_oci_core_securityList.SecurityList;
        publicSubnet: _pulumi_oci_core_subnet.Subnet;
        privateSubnet: _pulumi_oci_core_subnet.Subnet;
    };
    edge: _pulumi_oci_core_instance.Instance;
    worker: _pulumi_oci_core_instance.Instance;
    database: _pulumi_oci_database_autonomousDatabase.AutonomousDatabase;
    vault: _pulumi_oci_kms_vault.Vault;
    key: _pulumi_oci_kms_key.Key;
    bucket: _pulumi_oci_objectstorage_bucket.Bucket;
    bindings: {
        edgeHost: pulumi.Output<string>;
        edgePrivateAddress: pulumi.Output<string>;
        workerPrivateAddress: pulumi.Output<string>;
        databaseId: pulumi.Output<string>;
        databaseConnection: pulumi.Output<string>;
        vaultId: pulumi.Output<string>;
        keyId: pulumi.Output<string>;
        bucket: pulumi.Output<string>;
        namespace: pulumi.Output<string>;
    };
};

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Preset resource prefix; must match the lowercase naming grammar.
`args`	`OciAdbPresetArgs`	Yes	Explicit OCI compartment, reviewed images, SSH CIDR, database version/password and object namespace.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

{ network: { vcn: _pulumi_oci_core_vcn.Vcn; dhcpOptions: _pulumi_oci_core_dhcpOptions.DhcpOptions; internetGateway: _pulumi_oci_core_internetGateway.InternetGateway; natGateway: _pulumi_oci_core_natGateway.NatGateway; serviceGateway: _pulumi_oci_core_serviceGateway.ServiceGateway \| undefined; publicRoutes: _pulumi_oci_core_routeTable.RouteTable; privateRoutes: _pulumi_oci_core_routeTable.RouteTable; publicSecurityList: _pulumi_oci_core_securityList.SecurityList; privateSecurityList: _pulumi_oci_core_securityList.SecurityList; publicSubnet: _pulumi_oci_core_subnet.Subnet; privateSubnet: _pulumi_oci_core_subnet.Subnet; }; edge: _pulumi_oci_core_instance.Instance; worker: _pulumi_oci_core_instance.Instance; database: _pulumi_oci_database_autonomousDatabase.AutonomousDatabase; vault: _pulumi_oci_kms_vault.Vault; key: _pulumi_oci_kms_key.Key; bucket: _pulumi_oci_objectstorage_bucket.Bucket; bindings: { edgeHost: pulumi.Output<string>; edgePrivateAddress: pulumi.Output<string>; workerPrivateAddress: pulumi.Output<string>; databaseId: pulumi.Output<string>; databaseConnection: pulumi.Output<string>; vaultId: pulumi.Output<string>; keyId: pulumi.Output<string>; bucket: pulumi.Output<string>; namespace: pulumi.Output<string>; }; }

The network, edge/worker resources, database, Vault/key, bucket and binding Outputs.

Remarks

Registers real Pulumi resources when invoked. Requires

Errors and rejections

Invalid prefix or unrestricted/invalid SSH CIDR fails immediately; provider/resource registration and apply errors propagate.

Example

import { createOciAdbPreset } from '@alneas/eaos-cli/presets/oci-adb'
export function defineHostResource(args: Parameters<typeof createOciAdbPreset>[1], options?: Parameters<typeof createOciAdbPreset>[2]) { return createOciAdbPreset('example', args, options) }

[FUNCTION] `createOciAuthToken`

Declare an OCI user authentication token and expose its value as a Pulumi secret Output.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/vault.

Signature

declare function createOciAuthToken(name: string, args: OciAuthTokenArgs, options?: pulumi.CustomResourceOptions): {
    authToken: _pulumi_oci_identity_authToken.AuthToken;
    token: pulumi.Output<string>;
};

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Logical resource name.
`args`	`OciAuthTokenArgs`	Yes	User identity, optional description and shallow native overrides.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

{ authToken: _pulumi_oci_identity_authToken.AuthToken; token: pulumi.Output<string>; }

The AuthToken resource and secret-wrapped token Output.

Remarks

Creation can issue real credentials during Pulumi apply. The host owns rotation, distribution and access; never unwrap the token into logs or public outputs. Importing the module alone does not run a Pulumi update.

Errors and rejections

Provider/resource registration errors propagate.

Example

import { createOciAuthToken } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciAuthToken>[1], options?: Parameters<typeof createOciAuthToken>[2]) { return createOciAuthToken('example', args, options) }

[FUNCTION] `createOciAutonomousDatabase`

Declare an OCI Autonomous Database with an explicit default profile or unchanged native arguments.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/database.

Signature

declare function createOciAutonomousDatabase(name: string, args: OciAutonomousDatabaseArgs, options?: pulumi.CustomResourceOptions): _pulumi_oci_database_autonomousDatabase.AutonomousDatabase;

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Exact Pulumi logical name.
`args`	`OciAutonomousDatabaseArgs`	Yes	Either explicit free-oltp settings including nonempty endpoint ACL, or defaults=none with full native arguments.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

_pulumi_oci_database_autonomousDatabase.AutonomousDatabase

The native AutonomousDatabase resource.

Remarks

New free-oltp declarations default to protection, server-auth TLS and disabled autoscaling. Password values are secret Outputs. No DDL, wallets, IAM configuration or implicit adoption; provider inputs/overrides must be reviewed by the host. Importing the module alone does not run a Pulumi update.

Errors and rejections

Unknown profiles or absent required version/password/ACL fail immediately; provider errors propagate.

Example

import { createOciAutonomousDatabase } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciAutonomousDatabase>[1], options?: Parameters<typeof createOciAutonomousDatabase>[2]) { return createOciAutonomousDatabase('example', args, options) }

[FUNCTION] `createOciBastion`

Declare the OCI Bastion service with an explicit nonempty client CIDR allowlist.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/access.

Signature

declare function createOciBastion(name: string, args: OciBastionArgs, options?: pulumi.CustomResourceOptions): _pulumi_oci_bastion_bastion.Bastion;

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Exact Pulumi logical name.
`args`	`OciBastionArgs`	Yes	Compartment, target subnet, client allowlist and optional TTL/native overrides.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

_pulumi_oci_bastion_bastion.Bastion

The native Bastion resource.

Remarks

Default session TTL is 10800 seconds. Does not create sessions, IAM policies or SSH tunnels. Deferred Output allowlists are validated by the provider. Importing the module alone does not run a Pulumi update.

Errors and rejections

Missing or empty immediate allowlists fail; provider validation/errors propagate.

Example

import { createOciBastion } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciBastion>[1], options?: Parameters<typeof createOciBastion>[2]) { return createOciBastion('example', args, options) }

[FUNCTION] `createOciCompute`

Declare an OCI instance using an explicit image and host-controlled customization.

Imports: @alneas/eaos-cli/presets/oci-adb/infra.

Signature

declare function createOciCompute(name: string, args: OciComputeArgs, options?: pulumi.CustomResourceOptions): _pulumi_oci_core_instance.Instance;

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Exact Pulumi logical resource name.
`args`	`OciComputeArgs`	Yes	Compartment, domain, subnet, image and optional shape/storage/bootstrap overrides.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

_pulumi_oci_core_instance.Instance

The native OCI Instance resource.

Remarks

Defaults to a 50 GiB disposable boot volume and Docker cloud-init unless bootstrap.containerRuntime=none. Explicit instance metadata/user_data takes precedence; existing host adoption and replacement policy remain host-owned. Importing the module alone does not run a Pulumi update.

Errors and rejections

Provider/resource registration errors propagate.

Example

import { createOciCompute } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciCompute>[1], options?: Parameters<typeof createOciCompute>[2]) { return createOciCompute('example', args, options) }

[FUNCTION] `createOciNetwork`

Declare a public OCI VCN/subnet with internet egress and explicitly supplied ingress rules.

Imports: @alneas/eaos-cli/presets/oci-adb/infra.

Signature

declare function createOciNetwork(name: string, args: OciNetworkArgs, options?: pulumi.CustomResourceOptions): {
    vcn: _pulumi_oci_core_vcn.Vcn;
    gateway: _pulumi_oci_core_internetGateway.InternetGateway;
    routes: _pulumi_oci_core_routeTable.RouteTable;
    securityList: _pulumi_oci_core_securityList.SecurityList;
    subnet: _pulumi_oci_core_subnet.Subnet;
};

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Resource prefix for the network child resources.
`args`	`OciNetworkArgs`	Yes	Compartment and optional VCN/subnet ranges and ingress rules.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

{ vcn: _pulumi_oci_core_vcn.Vcn; gateway: _pulumi_oci_core_internetGateway.InternetGateway; routes: _pulumi_oci_core_routeTable.RouteTable; securityList: _pulumi_oci_core_securityList.SecurityList; subnet: _pulumi_oci_core_subnet.Subnet; }

The VCN, internet gateway, route table, security list and public subnet.

Remarks

Defaults to VCN 10.0.0.0/16 and public subnet 10.0.1.0/24, allows all outbound traffic and no inbound rules unless supplied. Does not implement the separate two-subnet private-network preset. Importing the module alone does not run a Pulumi update.

Errors and rejections

Provider/resource registration errors propagate.

Example

import { createOciNetwork } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciNetwork>[1], options?: Parameters<typeof createOciNetwork>[2]) { return createOciNetwork('example', args, options) }

[FUNCTION] `createOciNetworkLoadBalancer`

Declare a TCP OCI network load balancer and one backend per uniquely named listener.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/access.

Signature

declare function createOciNetworkLoadBalancer(name: string, args: OciNetworkLoadBalancerArgs, options?: pulumi.CustomResourceOptions): {
    loadBalancer: _pulumi_oci_networkloadbalancer_networkLoadBalancer.NetworkLoadBalancer;
    listeners: Record<string, OciNlbListenerResources>;
};

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Default resource prefix.
`args`	`OciNetworkLoadBalancerArgs`	Yes	Compartment, subnet, target ID and optional listener/resource overrides.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

{ loadBalancer: _pulumi_oci_networkloadbalancer_networkLoadBalancer.NetworkLoadBalancer; listeners: Record<string, OciNlbListenerResources>; }

The load balancer and listener resources keyed by listener key.

Remarks

Defaults to public TCP 80/443 forwarding and TCP backend health checks. TLS termination, client ingress policy and application authorization remain host-owned; native overrides are shallow. Importing the module alone does not run a Pulumi update.

Errors and rejections

Empty/duplicate/invalid listener keys or duplicate/out-of-range ports fail before resource registration; provider errors propagate.

Example

import { createOciNetworkLoadBalancer } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciNetworkLoadBalancer>[1], options?: Parameters<typeof createOciNetworkLoadBalancer>[2]) { return createOciNetworkLoadBalancer('example', args, options) }

[FUNCTION] `createOciNlbIngressRules`

Build backend TCP ingress rules for the selected NLB ports and client source CIDRs.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/access.

Signature

declare function createOciNlbIngressRules(options?: OciNlbIngressRulesOptions): NonNullable<oci.core.SecurityListArgs['ingressSecurityRules']>;

Parameters

Name	Type	Required	Description
`options`	`OciNlbIngressRulesOptions`	No	ports defaults to 80/443, allowedCidrs defaults to world IPv4, and descriptionPrefix labels the rules.

Returns

NonNullable<oci.core.SecurityListArgs['ingressSecurityRules']>

One rule per selected port/CIDR pair.

Remarks

This helper does not validate port/CIDR values or reconcile NLB source-preservation settings. Review those against the actual forwarding configuration; no security list is changed by rendering.

Example

import { createOciNlbIngressRules } from '@alneas/eaos-cli/presets/oci-adb/infra'
const rules = createOciNlbIngressRules({ ports: [443], allowedCidrs: ['192.0.2.0/24'] })

[FUNCTION] `createOciPrivateNetwork`

Declare a two-subnet OCI network with separate public and private egress/security configuration.

Imports: @alneas/eaos-cli/presets/oci-adb/infra.

Signature

declare function createOciPrivateNetwork(name: string, args: OciPrivateNetworkArgs, options?: pulumi.CustomResourceOptions): {
    vcn: _pulumi_oci_core_vcn.Vcn;
    dhcpOptions: _pulumi_oci_core_dhcpOptions.DhcpOptions;
    internetGateway: _pulumi_oci_core_internetGateway.InternetGateway;
    natGateway: _pulumi_oci_core_natGateway.NatGateway;
    serviceGateway: _pulumi_oci_core_serviceGateway.ServiceGateway | undefined;
    publicRoutes: _pulumi_oci_core_routeTable.RouteTable;
    privateRoutes: _pulumi_oci_core_routeTable.RouteTable;
    publicSecurityList: _pulumi_oci_core_securityList.SecurityList;
    privateSecurityList: _pulumi_oci_core_securityList.SecurityList;
    publicSubnet: _pulumi_oci_core_subnet.Subnet;
    privateSubnet: _pulumi_oci_core_subnet.Subnet;
};

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Resource prefix for the network and its child resources.
`args`	`OciPrivateNetworkArgs`	Yes	Compartment, address ranges, ingress rules, optional service network and per-resource shallow overrides.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

{ vcn: _pulumi_oci_core_vcn.Vcn; dhcpOptions: _pulumi_oci_core_dhcpOptions.DhcpOptions; internetGateway: _pulumi_oci_core_internetGateway.InternetGateway; natGateway: _pulumi_oci_core_natGateway.NatGateway; serviceGateway: _pulumi_oci_core_serviceGateway.ServiceGateway \| undefined; publicRoutes: _pulumi_oci_core_routeTable.RouteTable; privateRoutes: _pulumi_oci_core_routeTable.RouteTable; publicSecurityList: _pulumi_oci_core_securityList.SecurityList; privateSecurityList: _pulumi_oci_core_securityList.SecurityList; publicSubnet: _pulumi_oci_core_subnet.Subnet; privateSubnet: _pulumi_oci_core_subnet.Subnet; }

The VCN, subnets, gateways, routes and security resources.

Remarks

No service-network lookup is implicit; omit it for NAT-only private egress. Overrides replace nested values, so the host must review routing and security effects. Importing the module alone does not run a Pulumi update.

Errors and rejections

Provider/resource registration errors propagate.

Example

import { createOciPrivateNetwork } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciPrivateNetwork>[1], options?: Parameters<typeof createOciPrivateNetwork>[2]) { return createOciPrivateNetwork('example', args, options) }

[FUNCTION] `createOciVault`

Declare an OCI KMS Vault with optional native argument overrides.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/vault.

Signature

declare function createOciVault(name: string, args: OciVaultArgs, options?: pulumi.CustomResourceOptions): _pulumi_oci_kms_vault.Vault;

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Logical name and default display name.
`args`	`OciVaultArgs`	Yes	Compartment and optional display name, vault type or shallow native overrides.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

_pulumi_oci_kms_vault.Vault

The native KMS Vault resource.

Remarks

Defaults to DEFAULT vault type. Credentials/state and protection/retention settings remain host-owned; the factory itself does not populate secrets. Importing the module alone does not run a Pulumi update.

Errors and rejections

Provider/resource registration errors propagate.

Example

import { createOciVault } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciVault>[1], options?: Parameters<typeof createOciVault>[2]) { return createOciVault('example', args, options) }

[FUNCTION] `createOciVaultKey`

Declare an OCI KMS master encryption key for a supplied Vault management endpoint.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/vault.

Signature

declare function createOciVaultKey(name: string, args: OciVaultKeyArgs, options?: pulumi.CustomResourceOptions): _pulumi_oci_kms_key.Key;

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Logical name and default display name.
`args`	`OciVaultKeyArgs`	Yes	Compartment, management endpoint, optional algorithm/length/protection and shallow overrides.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

_pulumi_oci_kms_key.Key

The native KMS Key resource.

Remarks

Defaults to AES, length 32 and SOFTWARE protection. Current code also defaults non-AES length to 32; supply the correct provider-supported length explicitly for other algorithms. Importing the module alone does not run a Pulumi update.

Errors and rejections

Provider/resource registration errors propagate; provider validation owns algorithm/length compatibility.

Example

import { createOciVaultKey } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciVaultKey>[1], options?: Parameters<typeof createOciVaultKey>[2]) { return createOciVaultKey('example', args, options) }

[FUNCTION] `createOciVaultSecret`

Declare an OCI Vault secret with secret-wrapped base64 content.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/vault.

Signature

declare function createOciVaultSecret(name: string, args: OciVaultSecretArgs, options?: pulumi.CustomResourceOptions): _pulumi_oci_vault_secret.Secret;

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Logical resource name.
`args`	`OciVaultSecretArgs`	Yes	Compartment, Vault/key IDs, secret name/content and optional already-base64/native overrides.
`options`	`pulumi.CustomResourceOptions`	No	Optional Pulumi resource options such as provider, parent, protection or adoption; host-owned.

Returns

_pulumi_oci_vault_secret.Secret

The native OCI Secret resource.

Remarks

Encodes UTF-8 content unless isAlreadyBase64=true and marks content secret. Native overrides are applied last and can replace secretContent; review secrecy and shape before apply. Importing the module alone does not run a Pulumi update.

Errors and rejections

Provider/resource registration errors and Output transformation failures propagate.

Example

import { createOciVaultSecret } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function defineHostResource(args: Parameters<typeof createOciVaultSecret>[1], options?: Parameters<typeof createOciVaultSecret>[2]) { return createOciVaultSecret('example', args, options) }

[FUNCTION] `createPluginDevApp`

Create a disposable local development app around a trusted plugin and scoped SQLite stores.

Imports: @alneas/eaos-cli/dev.

Signature

declare function createPluginDevApp(config: PluginDevConfig, options?: {
    root?: string;
}): Promise<{
    app: Hono<hono_types.BlankEnv, hono_types.BlankSchema, "/">;
    close(): Promise<void>;
}>;

Parameters

Name	Type	Required	Description
`config`	`PluginDevConfig`	Yes	Plugin definition and explicit contracts, local capabilities, clients and optional MCP bindings.
`options`	`{ root?: string; }`	No	Optional root for local source and client resolution.

Returns

Promise<{ app: Hono<hono_types.BlankEnv, hono_types.BlankSchema, "/">; close(): Promise<void>; }>

An object with the Hono app and async close(); close waits for owned jobs/contexts, closes databases and removes temporary storage.

Remarks

Allocates in-memory databases and temporary storage; trusted plugin code is not OS-sandboxed. This is not production identity or permission infrastructure. Use returned cleanup hooks when ending a session.

Errors and rejections

Rejects invalid contracts/migrations, mismatched MCP policy or failed local resource initialization.

Public members

`options.root`

Trusted source/client resolution root; defaults to process.cwd() when omitted.

Example

import { createPluginDevApp } from '@alneas/eaos-cli/dev'
export function createSandbox(config: Parameters<typeof createPluginDevApp>[0]) { return createPluginDevApp(config) }

[INTERFACE] `DatabaseBaselineCompilation`

Final schema SQL with the exact image and independent rebuild evidence.

Imports: @alneas/eaos-cli/baseline.

Signature

interface DatabaseBaselineCompilation {
    sql: string[];
    verification: {
        dialect: string;
        image: string;
        schemaSha256: string;
        rebuilt: true;
    };
}

Parameters

Name	Type	Required	Description
`sql`	`string[]`	Yes	Final schema statements extracted from the temporary database.
`verification`	`{ dialect: string; image: string; schemaSha256: string; rebuilt: true; }`	Yes	Dialect/image identity, canonical schema hash and rebuilt=true evidence from the independent schema comparison.

Returns

Type declaration; no runtime value.

Public members

`sql`

Final schema statements extracted from the temporary database.

`verification`

Dialect/image identity, canonical schema hash and rebuilt=true evidence from the independent schema comparison.

`verification.dialect`

Selected compiler dialect, postgres or oracle, recorded with the verification evidence.

`verification.image`

Exact digest-pinned local Docker image used to compile and independently rebuild the schema.

`verification.schemaSha256`

SHA-256 of JSON.stringify applied to the extracted source SQL statement array; Oracle rebuild comparison separately normalizes DDL.

`verification.rebuilt`

True only after source and independently rebuilt schema metadata compare equal; it is not evidence of host database adoption.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `DatabaseBaselineOptions`

Local Docker compiler image and startup limits for schema-baseline verification.

Imports: @alneas/eaos-cli/baseline.

Signature

interface DatabaseBaselineOptions {
    postgresImage?: string;
    oracleImage?: string;
    startupTimeoutMs?: number;
}

Parameters

Name	Type	Required	Description
`postgresImage`	`string`	No	Optional locally preloaded digest-pinned PostgreSQL image; defaults to baselineImages.postgres.
`oracleImage`	`string`	No	Optional locally preloaded digest-pinned Oracle image; defaults to baselineImages.oracle.
`startupTimeoutMs`	`number`	No	Local database startup deadline in milliseconds; defaults to 600000 and must be an integer from 1000 to 900000.

Returns

Type declaration; no runtime value.

Public members

`postgresImage`

Optional locally preloaded digest-pinned PostgreSQL image; defaults to baselineImages.postgres.

`oracleImage`

Optional locally preloaded digest-pinned Oracle image; defaults to baselineImages.oracle.

`startupTimeoutMs`

Local database startup deadline in milliseconds; defaults to 600000 and must be an integer from 1000 to 900000.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `defaultEoasPrivateIngressRules`

Build the private Kratos and worker API TCP ingress rules for the default EAOS layout.

Imports: @alneas/eaos-cli/presets/oci-adb/infra.

Signature

declare function defaultEoasPrivateIngressRules(source?: pulumi.Input<string>, callers?: {
    kratosPublicSource?: pulumi.Input<string>;
    workerApiSource?: pulumi.Input<string>;
}): NonNullable<oci.core.SecurityListArgs['ingressSecurityRules']>;

Parameters

Name	Type	Required	Description
`source`	`pulumi.Input<string>`	No	Source CIDR/Input; defaults to the VCN range 10.0.0.0/16.
`callers`	`{ kratosPublicSource?: pulumi.Input<string>; workerApiSource?: pulumi.Input<string>; }`	No	Optional per-service source overrides for Kratos public and worker API traffic.

Returns

NonNullable<oci.core.SecurityListArgs['ingressSecurityRules']>

Rules for TCP 4434, 4433 and 3000 using the supplied source scopes.

Remarks

Pure rule construction; it does not attach security lists or validate whether caller-supplied CIDRs are private. Hosts must avoid exposing administrative ports publicly.

Public members

`callers.kratosPublicSource`

Optional CIDR/Input overriding the common source for TCP 4433 Kratos public API traffic; omitted uses source.

`callers.workerApiSource`

Optional CIDR/Input overriding the common source for TCP 3000 worker API traffic; omitted uses source.

Example

import { defaultEoasPrivateIngressRules } from '@alneas/eaos-cli/presets/oci-adb/infra'
const rules = defaultEoasPrivateIngressRules('10.0.0.0/16')

[FUNCTION] `defineDevConfig`

Retain a typed development configuration without creating a server or persistence.

Imports: @alneas/eaos-cli/dev.

Signature

declare const defineDevConfig: (config: PluginDevConfig) => PluginDevConfig;

Parameters

Name	Type	Required	Description
`config`	`PluginDevConfig`	Yes	Explicit plugin definition and optional local test host capabilities.

Returns

PluginDevConfig

The same configuration object, without cloning or validation.

Remarks

The later development runtime validates contracts and allocates disposable state; defining configuration alone does not do so.

Example

import { defineDevConfig } from '@alneas/eaos-cli/dev'
import { definePlugin } from '@alneas/eaos-core'
const config = defineDevConfig({ plugin: definePlugin({ id: 'notes', entitlement: { tier: 'public' }, routes(router) { router.post('/ping', async () => ({ ready: true })) } }) })

[FUNCTION] `definePlatformOperations`

Retain typed trusted host operations without executing any supplied callback.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/operations.

Signature

declare const definePlatformOperations: (operations: PlatformOperations) => PlatformOperations;

Parameters

Name	Type	Required	Description
`operations`	`PlatformOperations`	Yes	Host-owned lock, lifecycle, health and deployment/bootstrap bindings.

Returns

PlatformOperations

The same host operations object, without cloning or execution.

Remarks

Host callbacks carry real capabilities. Configuration passthrough is not validation, approval or a deployment.

Example

import { definePlatformOperations } from '@alneas/eaos-cli/platform'
export function bindOperations(operations: Parameters<typeof definePlatformOperations>[0]) { return definePlatformOperations(operations) }

[FUNCTION] `deploymentAssetPaths`

Enumerate regular deployment-tree files in deterministic order while rejecting symbolic links.

Imports: @alneas/eaos-cli/platform/deployment-assets.

Signature

declare function deploymentAssetPaths(directory: string, prefix?: string): Promise<string[]>;

Parameters

Name	Type	Required	Description
`directory`	`string`	Yes	Built staging directory to inspect.
`prefix`	`string`	No	Optional relative traversal prefix, empty by default; caller owns its containment.

Returns

Promise<string[]>

Sorted relative file paths; Finder .DS_Store files are omitted.

Errors and rejections

Rejects encountered symlinks and filesystem read errors.

Example

import { deploymentAssetPaths } from '@alneas/eaos-cli/platform/deployment-assets'
export function stagedFiles(directory: string) { return deploymentAssetPaths(directory) }

[INTERFACE] `DeploymentContribution`

Hash-verified deployment contribution read from one immutable package inventory.

Imports: @alneas/eaos-cli/platform/deployment-plan.

Signature

interface DeploymentContribution {
    owner: string;
    artifact: string;
    inventorySha256: string;
    runtime?: string;
    functions: DeploymentInventory['functions'];
    database?: DeploymentInventory['database'];
    plugins: DeploymentInventory['plugins'];
    coverage: 'declared' | 'legacy-unclassified';
    verifiedAssets: number;
}

Parameters

Name	Type	Required	Description
`owner`	`string`	Yes	Exact package identity declared by the verified inventory.
`artifact`	`string`	Yes	Canonical inventory JSON path used for this contribution.
`inventorySha256`	`string`	Yes	SHA-256 of the exact immutable inventory bytes.
`runtime`	`string`	No	Optional declared runtime module path; inspection does not execute it.
`functions`	`DeploymentInventory['functions']`	Yes	Declared runtime function contributions, with source assets verified.
`database`	`DeploymentInventory['database']`	No	Optional adopted-history database contribution; does not run schema changes.
`plugins`	`DeploymentInventory['plugins']`	Yes	Optional declared plugins, components and adoption tasks.
`coverage`	`'declared' \| 'legacy-unclassified'`	Yes	declared for inventories with task declarations; legacy-unclassified otherwise.
`verifiedAssets`	`number`	Yes	Number of inventory assets whose exact bytes passed SHA-256 validation.

Returns

Type declaration; no runtime value.

Public members

`owner`

Exact package identity declared by the verified inventory.

`artifact`

Canonical inventory JSON path used for this contribution.

`inventorySha256`

SHA-256 of the exact immutable inventory bytes.

`runtime`

Optional declared runtime module path; inspection does not execute it.

`functions`

Declared runtime function contributions, with source assets verified.

`database`

Optional adopted-history database contribution; does not run schema changes.

`plugins`

Optional declared plugins, components and adoption tasks.

`coverage`

declared for inventories with task declarations; legacy-unclassified otherwise.

`verifiedAssets`

Number of inventory assets whose exact bytes passed SHA-256 validation.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `DeploymentInventory`

Compatibility re-export; its implementation and documentation are owned by the owning API reference.

Imports: @alneas/eaos-cli/platform.

Signature

interface DeploymentInventory {
    apiVersion: 1;
    owner: string;
    version?: string;
    runtime?: string;
    lifecycleBundle?: string[];
    functions: Array<{
        id: string;
        source: string;
        scope: 'tenant';
        requiredTenantBindings: string[];
    }>;
    database?: {
        source: string;
        mode: 'adopt-existing-history';
        tenantColumn: 'tenant_id';
    };
    assets: Array<{
        path: string;
        sha256: string;
    }>;
    plugins?: DeploymentPlugin[];
}

Parameters

Name	Type	Required	Description
`apiVersion`	`1`	Yes	See the upstream owning declaration.
`owner`	`string`	Yes	See the upstream owning declaration.
`version`	`string`	No	See the upstream owning declaration.
`runtime`	`string`	No	See the upstream owning declaration.
`lifecycleBundle`	`string[]`	No	See the upstream owning declaration.
`functions`	`Array<{ id: string; source: string; scope: 'tenant'; requiredTenantBindings: string[]; }>`	Yes	See the upstream owning declaration.
`database`	`{ source: string; mode: 'adopt-existing-history'; tenantColumn: 'tenant_id'; }`	No	See the upstream owning declaration.
`assets`	`Array<{ path: string; sha256: string; }>`	Yes	See the upstream owning declaration.
`plugins`	`DeploymentPlugin[]`	No	See the upstream owning declaration.

Returns

Type declaration; no runtime value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[TYPE] `DeploymentStatusContribution`

Deployment summary enriched with destination-specific adoption and task evidence.

Imports: @alneas/eaos-cli/platform/deployment-status.

Signature

type DeploymentStatusContribution = Omit<BaseSummary, 'plugins'> & {
    plugins: Array<Omit<BasePlugin, 'tasks' | 'components'> & {
        selected?: boolean;
        placementSha256?: string;
        tasks: Array<BasePlugin['tasks'][number] & {
            adopted?: boolean;
            executions?: DeploymentExecution[];
        }>;
        components: Array<BasePlugin['components'][number] & {
            adopted?: boolean;
            destinationIds?: string[];
        }>;
    }>;
    destinations?: PlacedSummary['destinations'];
    artifactExecutions?: PlacedSummary['artifactExecutions'];
    placementCoverage?: 'explicit';
};

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Type declaration; no runtime value.

Public members

`plugins`

Plugin status summaries with optional destination adoption and per-task execution evidence.

`plugins[].selected`

False when this application has not adopted the plugin; omitted in summaries without placement selection.

`plugins[].placementSha256`

Optional hash binding adopted component assignments to destination/runtime configuration.

`plugins[].tasks`

Per-task status extended with destination-specific adoption and execution evidence when placements are supplied.

`plugins[].tasks[].adopted`

Whether this task belongs to an adopted component assignment; false excludes it from required remaining work.

`plugins[].tasks[].executions`

Optional artifact/destination execution summaries with independently bound status and evidence.

`plugins[].components`

Declared components enriched with application adoption and assigned destination identities.

`plugins[].components[].adopted`

Whether this application explicitly selects the component for deployment.

`plugins[].components[].destinationIds`

Explicit destination IDs assigned to this component when placement-aware inspection is used.

`destinations`

Optional explicit deployment destinations included by placement-aware status inspection.

`artifactExecutions`

Optional artifact-scoped task executions shared across destination summaries.

`placementCoverage`

Whether declared destination placements are represented by verified status evidence.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `deployPlatformImage`

Deploy a reviewed prebuilt image using Kamal or constrained single-host OpenSSH transport.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/deploy.

Signature

declare function deployPlatformImage(options: PlatformImageDeployOptions): Promise<void>;

Parameters

Name	Type	Required	Description
`options`	`PlatformImageDeployOptions`	Yes	Explicit configFile and immutable version; optional transport, cwd, environment and registry credentials.

Returns

Promise<void>

Resolves without a value when the selected deployment commands succeed.

Remarks

Executes real Ruby/Kamal/SSH/Docker operations. Fixed-port replacement may stop the prior version and attempt rollback on failure; inspect actual host state before retrying. Does not build/push images, apply DB migrations or activate tenants. Credentials must come from trusted host bindings.

Errors and rejections

Rejects invalid versions/configuration, unsupported OpenSSH features, subprocess failures or failed rollback commands.

Example

import { deployPlatformImage } from '@alneas/eaos-cli/platform'
export function deployReviewed(options: Parameters<typeof deployPlatformImage>[0]) { return deployPlatformImage(options) }

[FUNCTION] `detectSecrets`

Scan plugin TypeScript, JavaScript and JSON files for configured credential patterns without printing matches.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/detect-secrets.

Signature

declare function detectSecrets(workspaceRoot: string, options: CommandOptions): Promise<void>;

Parameters

Name	Type	Required	Description
`workspaceRoot`	`string`	Yes	Trusted workspace containing the plugin.
`options`	`CommandOptions`	Yes	plugin is required; check rejects findings and autoFix only prints resolver guidance.

Returns

Promise<void>

Resolves without a value after reporting findings; does not edit or remove credentials.

Remarks

Skips node_modules, dist and .git. Pattern scanning cannot certify absence of all secrets; findings contain relative paths and redacted categories.

Errors and rejections

Rejects invalid plugin paths, filesystem errors, or detected patterns when check is true.

Example

import { detectSecrets } from '@alneas/eaos-cli/plugin-tools'
export async function scanNotes(root: string) { await detectSecrets(root, { plugin: 'notes', check: true }) }

[FUNCTION] `diagnosePlugin`

Print source-inspection diagnostics and optionally fail when unresolved issues remain.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/diagnose-plugin.

Signature

declare function diagnosePlugin(root: string, options: CommandOptions): Promise<void>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted workspace root.
`options`	`CommandOptions`	Yes	plugin is required; format=json prints structured data and check rejects unresolved issues.

Returns

Promise<void>

Resolves without a value after printing the report.

Errors and rejections

Rejects if plugin is missing, source inspection fails, or check finds issues.

Example

import { diagnosePlugin } from '@alneas/eaos-cli/plugin-tools'
export async function diagnoseNotes(root: string) { await diagnosePlugin(root, { plugin: 'notes', check: true }) }

[CONSTANT] `emailIdentitySchema`

Default email-identity JSON Schema used while rendering the platform identity configuration.

Imports: @alneas/eaos-cli/platform/render.

Signature

declare const emailIdentitySchema: {
    $schema: string;
    title: string;
    type: string;
    properties: {
        traits: {
            type: string;
            properties: {
                email: {
                    type: string;
                    format: string;
                    'ory.sh/kratos': {
                        credentials: {
                            password: {
                                identifier: boolean;
                            };
                        };
                        verification: {
                            via: string;
                        };
                    };
                };
                name: {
                    type: string;
                };
            };
            required: string[];
            additionalProperties: boolean;
        };
    };
    required: string[];
    additionalProperties: boolean;
};

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `executePlatformOperation`

Execute a reviewed release/bootstrap under local and shared host locks with durable step receipts.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/operations.

Signature

declare function executePlatformOperation(root: string, operation: 'release' | 'bootstrap', options?: PlatformOperationOptions, ports?: OperationPorts): Promise<{
    mode: "plan-only";
    operation: "release" | "bootstrap";
    inputSha256: string;
    preset: string | undefined;
    roles: {
        role: "backend" | "frontend" | "worker";
        image: string;
        version: string;
    }[];
    stages: string[];
    selectedPlugins: {
        owner: string;
        id: string;
    }[];
    requires: string;
} | {
    receipt: string;
    status: "succeeded";
    id: string;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Existing application root.
`operation`	`'release' \| 'bootstrap'`	Yes	Explicit release or bootstrap operation.
`options`	`PlatformOperationOptions`	No	plan returns inspection only; actual bootstrap additionally requires an explicit Pulumi stack.
`ports`	`OperationPorts`	No	Trusted host operations and optional process/deploy/fetch ports; missing ports use real host implementations.

Returns

Promise<{ mode: "plan-only"; operation: "release" \| "bootstrap"; inputSha256: string; preset: string \| undefined; roles: { role: "backend" \| "frontend" \| "worker"; image: string; version: string; }[]; stages: string[]; selectedPlugins: { owner: string; id: string; }[]; requires: string; } \| { receipt: string; status: "succeeded"; id: string; }>

The plan in plan mode; after real execution, an object with the persisted receipt path, succeeded status, and operation UUID. The receipt contents are stored in the referenced file.

Remarks

Actual execution can apply infrastructure and migrations, deploy roles and issue administrator setup data. Failure evidence is retained; completed external effects are not generally rolled back. Never retry blindly or treat plan mode as approval. New tenants are not automatically enabled.

Errors and rejections

Rejects invalid or changed inputs, held locks, dirty/stale lifecycle plans, missing capabilities or any failed infrastructure/deployment/health step.

Example

import { executePlatformOperation } from '@alneas/eaos-cli/platform'
export function inspectRelease(root: string) { return executePlatformOperation(root, 'release', { plan: true }) }

[FUNCTION] `expandPreset`

Expand supported OCI preset defaults without downloading images or performing infrastructure work.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/preset.

Signature

declare function expandPreset(input: unknown): any;

Parameters

Name	Type	Required	Description
`input`	`unknown`	Yes	Untrusted manifest value; a manifest without preset is returned unchanged.

Returns

any

The original value without a preset, or a new manifest with explicit preset defaults.

Remarks

Default dev image tags are local build names, not claims of published registry availability.

Errors and rejections

If the preset, package selections or deployment overrides have an invalid shape.

Example

import { expandPreset } from '@alneas/eaos-cli/platform'
const expanded = expandPreset({ preset: 'oci-adb', platform: { appName: 'example', baseDomain: 'example.com' } })

[FUNCTION] `findPluginDir`

Resolve an existing plugin directory while rejecting symbolic links and paths outside the plugin root.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/utils.

Signature

declare function findPluginDir(workspaceRoot: string, pluginId: string): string;

Parameters

Name	Type	Required	Description
`workspaceRoot`	`string`	Yes	Trusted workspace containing the plugins directory.
`pluginId`	`string`	Yes	Lowercase hyphen-separated plugin identifier.

Returns

string

The joined plugin directory path using the supplied workspaceRoot; containment is checked using real paths, but the returned path is not canonicalized.

Errors and rejections

If the identifier, directory or resolved containment is invalid; filesystem errors propagate.

Example

import { findPluginDir } from '@alneas/eaos-cli/plugin-tools'
export function locateNotes(root: string) { return findPluginDir(root, 'notes') }

[CONSTANT] `frameworkVersion`

Compatible framework version injected by the build, falling back to the source package version when running source.

Imports: @alneas/eaos-cli/version.

Signature

declare const frameworkVersion: string;

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[CONSTANT] `generatedEnd`

Closing marker delimiting the single CLI-owned plugin contract block inside AGENTS.md.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/sync-agents-md.

Signature

declare const generatedEnd = "<!-- eaos:generated:end -->";

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[CONSTANT] `generatedStart`

Opening marker delimiting the single CLI-owned plugin contract block inside AGENTS.md.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/sync-agents-md.

Signature

declare const generatedStart = "<!-- eaos:generated:start -->";

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `generateMcpTools`

Scan source service methods and write a deliberately unbound MCP tool draft.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/generate-mcp-tools.

Signature

declare function generateMcpTools(workspaceRoot: string, options: CommandOptions): Promise<void>;

Parameters

Name	Type	Required	Description
`workspaceRoot`	`string`	Yes	Trusted workspace containing the plugin.
`options`	`CommandOptions`	Yes	plugin is required; check compares the draft and write permits replacement.

Returns

Promise<void>

Resolves without a value; a missing services directory is reported and skipped.

Remarks

Uses source-pattern heuristics, not semantic method validation. Generated handlers throw until connected to real domain services; no tool is registered or executed.

Errors and rejections

Rejects missing plugin selection, invalid paths or draft/filesystem errors.

Example

import { generateMcpTools } from '@alneas/eaos-cli/plugin-tools'
export async function checkTools(root: string) { await generateMcpTools(root, { plugin: 'notes', check: true }) }

[FUNCTION] `generatePlatform`

Render managed platform configuration from reviewed installed package metadata.

Imports: @alneas/eaos-cli/platform.

Signature

declare function generatePlatform(projectRoot: string, options?: {
    config?: string;
    check?: boolean;
}): Promise<{
    status: 'generated' | 'current';
    directory: string;
    files: number;
}>;

Parameters

Name	Type	Required	Description
`projectRoot`	`string`	Yes	Trusted application project root.
`options`	`{ config?: string; check?: boolean; }`	No	Optional config path and check flag; check verifies generated outputs without replacing them.

Returns

Promise<{ status: 'generated' \| 'current'; directory: string; files: number; }>

Generation summary for the selected project and managed files.

Remarks

Generates configuration and staging metadata, not live infrastructure or tenant activation. Source scripts and package runtime factories retain their separate host trust boundaries.

Errors and rejections

Rejects invalid manifests, unresolved placements, edited/unmanaged generated files and filesystem failures.

Public members

`options.config`

Workspace-relative application manifest path; defaults to eaos.platform.json.

`options.check`

When true, verify managed output is current without replacing files; false/omitted generates only reviewed managed changes.

`result.status`

Generated when managed outputs were written, or current when existing outputs already match the receipt (including successful check mode).

`result.directory`

Resolved managed output directory under the trusted application project root.

`result.files`

Count of rendered managed content files represented by the generation receipt.

Example

import { generatePlatform } from '@alneas/eaos-cli/platform'
export function checkPlatform(root: string) { return generatePlatform(root, { check: true }) }

[FUNCTION] `generatePlugin`

Write a new plugin scaffold with explicit tier and host-owned implementation placeholders.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/generate-plugin.

Signature

declare function generatePlugin(root: string, options: CommandOptions): Promise<void>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted workspace root for the generated plugin directory.
`options`	`CommandOptions`	Yes	Plugin name/description/tier and optional output/addon/quota/tenant selections.

Returns

Promise<void>

Resolves without a value after writing scaffold files.

Remarks

Writes source drafts, metadata, guides and inventory declarations. Generated handlers require real host bindings; generation never proves persistence, enables tenants or applies infrastructure.

Errors and rejections

Rejects invalid identifiers/tier/quota/allowlists, unsafe or existing destinations and filesystem failures.

Example

import { generatePlugin } from '@alneas/eaos-cli/plugin-tools'
export function scaffoldNotes(root: string) { return generatePlugin(root, { name: 'notes', tier: 'public' }) }

[FUNCTION] `getAllPluginIds`

List direct plugin directories that contain a manifest.ts file.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/utils.

Signature

declare function getAllPluginIds(workspaceRoot: string): string[];

Parameters

Name	Type	Required	Description
`workspaceRoot`	`string`	Yes	Workspace whose plugins directory is inspected.

Returns

string[]

Discovered directory names, or an empty array when plugins is absent; ordering follows the filesystem.

Remarks

This is discovery only; names are not an activation or authorization decision.

Errors and rejections

Filesystem enumeration errors propagate.

Example

import { getAllPluginIds } from '@alneas/eaos-cli/plugin-tools'
export function listPlugins(root: string) { return getAllPluginIds(root) }

[CONSTANT] `googleMapperFile`

Generated relative filename for the Google verified-email identity mapper.

Imports: @alneas/eaos-cli/platform/render.

Signature

declare const googleMapperFile = "kratos/google-mapper.jsonnet";

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[CONSTANT] `googleVerifiedEmailMapper`

Jsonnet identity-mapping source that accepts the configured Google identity claims.

Imports: @alneas/eaos-cli/platform/render.

Signature

declare const googleVerifiedEmailMapper = "local claims = std.extVar('claims');\nassert std.objectHas(claims, 'email_verified') && claims.email_verified == true : 'Verified email required';\nassert std.objectHas(claims, 'email') && std.type(claims.email) == 'string' && std.length(claims.email) > 0 : 'Email required';\n{ identity: { traits: { email: claims.email }, verified_addresses: [{ via: 'email', value: claims.email }] } }\n";

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `inferContracts`

Infer a draft service interface from asynchronous source-method signatures.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/infer-contracts.

Signature

declare function inferContracts(workspaceRoot: string, options: CommandOptions): Promise<void>;

Parameters

Name	Type	Required	Description
`workspaceRoot`	`string`	Yes	Trusted workspace containing the plugin.
`options`	`CommandOptions`	Yes	plugin is required; check compares and write permits replacement of the generated draft.

Returns

Promise<void>

Resolves without a value after writing/checking, or skips when the services directory is absent.

Remarks

Pattern matching does not prove runtime contracts; review nested types and implementation semantics before adopting the interface.

Errors and rejections

Rejects invalid plugin selection, protected/stale drafts or filesystem errors.

Example

import { inferContracts } from '@alneas/eaos-cli/plugin-tools'
export async function checkInferred(root: string) { await inferContracts(root, { plugin: 'notes', check: true }) }

[FUNCTION] `initializePreset`

Acquire initial Pulumi source while refusing to replace existing customized files.

Imports: @alneas/eaos-cli/presets/oci-adb, @alneas/eaos-cli/presets/oci-adb/template.

Signature

declare function initializePreset(root: string, config?: string): Promise<{
    directory: string;
    files: number;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted application root with the selected preset.
`config`	`string`	No	Workspace-relative application manifest path; defaults to eaos.platform.json.

Returns

Promise<{ directory: string; files: number; }>

The Pulumi directory path and generated file count.

Remarks

Preflights the whole file set and writes new files exclusively. Does not install packages, run preview/update or read credentials; existing customizations stay host-owned.

Errors and rejections

Rejects missing preset selection, unsafe paths or existing files that differ from the generated template; filesystem failures propagate.

Example

import { initializePreset } from '@alneas/eaos-cli/presets/oci-adb'
export function initializeHost(root: string) { return initializePreset(root) }

[FUNCTION] `inspectDeploymentStatus`

Summarize deployment task evidence after verifying its inventory and journal bindings.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/deployment-status.

Signature

declare function inspectDeploymentStatus(inventories: string[], options?: {
    receipts?: string[];
    target?: DeploymentTarget;
    config?: string;
    projectRoot?: string;
}): Promise<{
    mode: string;
    complete: boolean;
    contributions: DeploymentStatusContribution[];
}>;

Parameters

Name	Type	Required	Description
`inventories`	`string[]`	Yes	Immutable deployment inventory paths to inspect.
`options`	`{ receipts?: string[]; target?: DeploymentTarget; config?: string; projectRoot?: string; }`	No	Optional receipts, target and explicit placement bindings used to scope the summary.

Returns

Promise<{ mode: string; complete: boolean; contributions: DeploymentStatusContribution[]; }>

Contribution status summaries; missing evidence remains visibly incomplete.

Remarks

Inspection does not execute tasks or turn absent evidence into success.

Errors and rejections

Rejects changed inventories, invalid evidence or incompatible placement/target bindings.

Public members

`options.receipts`

Optional deployment evidence journal paths; omission leaves required work pending rather than assuming success.

`options.target`

Optional exact environment/backend/database/tenant context used to select matching scoped evidence; placement-aware inspection derives database identity from destinations.

`options.config`

Optional workspace-relative application manifest path providing explicit placements and binding revisions; omitted uses unplaced evidence summaries.

`options.projectRoot`

Root against which the optional placement config is resolved; defaults to process.cwd().

Example

import { inspectDeploymentStatus } from '@alneas/eaos-cli/platform'
export function inspectRelease(inventory: string) { return inspectDeploymentStatus([inventory]) }

[FUNCTION] `inspectPlugin`

Statically inspect a plugin manifest and source contracts without executing the plugin.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/inspect.

Signature

declare function inspectPlugin(root: string, pluginId: string): PluginInspection;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted workspace root.
`pluginId`	`string`	Yes	Plugin identifier whose manifest and sources are read.

Returns

PluginInspection

Source-derived plugin metadata, tools, policies and unresolved inspection issues.

Remarks

Inspection issues must be resolved before generated metadata is treated as an executable contract.

Errors and rejections

Invalid plugin paths and source/filesystem failures propagate.

Example

import { inspectPlugin } from '@alneas/eaos-cli/plugin-tools'
export function inspectNotes(root: string) { return inspectPlugin(root, 'notes') }

[FUNCTION] `json`

Serialize a JSON-compatible value with two-space indentation and a trailing newline.

Imports: @alneas/eaos-cli/platform/render.

Signature

declare const json: (value: unknown) => string;

Parameters

Name	Type	Required	Description
`value`	`unknown`	Yes	Value to serialize; must be JSON-compatible.

Returns

string

Serialized text ending in a newline.

Errors and rejections

Circular references or BigInt throw through JSON.stringify; unsupported values follow JSON.stringify semantics.

Example

import { json } from '@alneas/eaos-cli/platform/render'
const text = json({ ready: true })

[INTERFACE] `KamalDeployment`

Explicit SSH host, role, registry and runtime-file inputs for Kamal configuration.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/kamal.

Signature

interface KamalDeployment {
    host: string;
    arch?: 'amd64' | 'arm64';
    ssh?: {
        user?: string;
        port?: number;
    };
    services?: {
        backend?: string;
        frontend?: string;
    };
    registry?: {
        usernameSecret?: string;
        passwordSecret?: string;
    };
    runtimeDirectory?: string;
    runtimeFiles?: {
        kratosConfig?: string;
        databasePassword?: string;
        tlsDirectory?: string;
    };
    worker?: {
        host: string;
        privateAddress: string;
        kratosAdminUrl: string;
        arch?: 'amd64' | 'arm64';
        ssh?: {
            user?: string;
            port?: number;
        };
        service?: string;
    };
    agentRuntime?: {
        host: string;
        privateAddress?: string;
        arch?: 'amd64' | 'arm64';
        port?: number;
        ssh?: {
            user?: string;
            port?: number;
        };
        service?: string;
        runtimeDirectory?: string;
        tlsDirectory?: string;
    };
}

Parameters

Name	Type	Required	Description
`host`	`string`	Yes	Reviewed SSH host or configured alias selected by the host.
`arch`	`'amd64' \| 'arm64'`	No	Container/host architecture, amd64 or arm64.
`ssh`	`{ user?: string; port?: number; }`	No	Optional trusted SSH user and port configuration.
`services`	`{ backend?: string; frontend?: string; }`	No	Explicit backend/frontend service names.
`registry`	`{ usernameSecret?: string; passwordSecret?: string; }`	No	Registry credential environment-binding names; plaintext values are supplied by the host at execution.
`runtimeDirectory`	`string`	No	Host runtime directory for generated configuration and secrets mounts.
`runtimeFiles`	`{ kratosConfig?: string; databasePassword?: string; tlsDirectory?: string; }`	No	Registered host paths for identity configuration, database password and optional TLS files.
`worker`	`{ host: string; privateAddress: string; kratosAdminUrl: string; arch?: 'amd64' \| 'arm64'; ssh?: { user?: string; port?: number; }; service?: string; }`	No	Optional separate worker host and private service endpoints.
`agentRuntime`	`{ host: string; privateAddress?: string; arch?: 'amd64' \| 'arm64'; port?: number; ssh?: { user?: string; port?: number; }; service?: string; runtimeDirectory?: string; tlsDirectory?: string; }`	No	Optional separate agent-runtime host, port and reviewed network bindings.

Returns

Type declaration; no runtime value.

Public members

`host`

Reviewed SSH host or configured alias selected by the host.

`arch`

Container/host architecture, amd64 or arm64.

`ssh`

Optional trusted SSH user and port configuration.

`ssh.user`

Main-host SSH username; defaults to root and must match the lowercase POSIX-like username grammar.

`ssh.port`

Main-host SSH port, integer 1–65535; defaults to 22.

`services`

Explicit backend/frontend service names.

`services.backend`

Backend Kamal service name; defaults to appName-backend and must differ from frontend.

`services.frontend`

Frontend Kamal service name; defaults to appName-frontend and must differ from backend.

`registry`

Registry credential environment-binding names; plaintext values are supplied by the host at execution.

`registry.usernameSecret`

Uppercase registry-username environment binding; defaults to KAMAL_REGISTRY_USERNAME.

`registry.passwordSecret`

Uppercase registry-password environment binding; defaults to KAMAL_REGISTRY_PASSWORD.

`runtimeDirectory`

Host runtime directory for generated configuration and secrets mounts.

`runtimeFiles`

Registered host paths for identity configuration, database password and optional TLS files.

`runtimeFiles.kratosConfig`

Absolute host Kratos runtime YAML path; defaults to runtimeDirectory/kratos-runtime.yml and cannot overlap other runtime/migration paths.

`runtimeFiles.databasePassword`

Absolute host database-password file path; defaults to runtimeDirectory/postgres-password and cannot overlap other runtime/migration paths.

`runtimeFiles.tlsDirectory`

Absolute host platform TLS directory; defaults to runtimeDirectory/tls and cannot overlap other runtime/migration paths.

`worker`

Optional separate worker host and private service endpoints.

`worker.host`

Reviewed worker SSH host/alias, required to differ from the main host.

`worker.privateAddress`

Required host-selected worker address used for private application routing.

`worker.kratosAdminUrl`

Required host-selected HTTP(S) Kratos administrator URL for the worker; host network policy must keep administration private.

`worker.arch`

Worker image architecture; defaults to the main deployment architecture.

`worker.ssh`

Trusted per-role SSH overrides; omitted fields inherit the main raw SSH input and selected main SSH port.

`worker.ssh.user`

Role SSH username; omitted uses the explicit main ssh.user input. If neither is supplied, role resolution rejects rather than inheriting the main root default.

`worker.ssh.port`

Role SSH port, integer 1–65535; defaults to the selected main SSH port.

`worker.service`

Worker Kamal service name; defaults to appName-worker.

`agentRuntime`

Optional separate agent-runtime host, port and reviewed network bindings.

`agentRuntime.host`

Reviewed agent-runtime SSH host/alias; validation does not prove private network isolation.

`agentRuntime.privateAddress`

Optional host-selected address advertised for private runtime connections; omitted remains absent.

`agentRuntime.arch`

Agent-runtime image architecture; defaults to arm64 independently of the main host.

`agentRuntime.port`

Agent service port, integer 1–65535; defaults to 8443.

`agentRuntime.ssh`

Trusted per-role SSH overrides; omitted fields inherit the main raw SSH input and selected main SSH port.

`agentRuntime.ssh.user`

Role SSH username; omitted uses the explicit main ssh.user input. If neither is supplied, role resolution rejects rather than inheriting the main root default.

`agentRuntime.ssh.port`

Role SSH port, integer 1–65535; defaults to the selected main SSH port.

`agentRuntime.service`

Agent-runtime Kamal service name; defaults to appName-agent-runtime.

`agentRuntime.runtimeDirectory`

Absolute host runtime directory; defaults to main runtimeDirectory/agent-runtime and must avoid platform runtime/migration overlap.

`agentRuntime.tlsDirectory`

Absolute agent TLS directory; defaults to the agent runtimeDirectory/tls and must avoid platform runtime/migration overlap.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `KamalSecretsTemplateOptions`

Host-supplied registry identity and Pulumi path used while rendering the current Kamal resolver template.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/kamal-secrets.

Signature

interface KamalSecretsTemplateOptions {
    defaultRegistryUser?: string;
    identityDomain?: string;
    tenancyNamespace?: string;
    username?: string;
    authTokenSecretName?: string;
    pulumiDir?: string;
}

Parameters

Name	Type	Required	Description
`defaultRegistryUser`	`string`	No	Explicit registry username, taking precedence over the composed namespace/domain/username.
`identityDomain`	`string`	No	Identity domain used when composing a username; defaults to Default.
`tenancyNamespace`	`string`	No	Optional OCI namespace used with username to compose the registry user.
`username`	`string`	No	Optional user name/email used with tenancyNamespace to compose the registry user.
`authTokenSecretName`	`string`	No	Reserved option currently not consumed by the renderer; changing it does not alter secret lookup.
`pulumiDir`	`string`	No	Pulumi working directory interpolated into the resolver script; defaults to apps/pulumi/Pulumi. Supply trusted shell-safe configuration.

Returns

Type declaration; no runtime value.

Public members

`defaultRegistryUser`

Explicit registry username, taking precedence over the composed namespace/domain/username.

`identityDomain`

Identity domain used when composing a username; defaults to Default.

`tenancyNamespace`

Optional OCI namespace used with username to compose the registry user.

`username`

Optional user name/email used with tenancyNamespace to compose the registry user.

`authTokenSecretName`

Reserved option currently not consumed by the renderer; changing it does not alter secret lookup.

`pulumiDir`

Pulumi working directory interpolated into the resolver script; defaults to apps/pulumi/Pulumi. Supply trusted shell-safe configuration.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `loadRegisteredPlatformModules`

Import verified trusted package factories and validate their returned platform contributions.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/packages.

Signature

declare function loadRegisteredPlatformModules(root: string, config?: string, options?: {
    tenantIds?: string[];
    bindings?: Record<string, unknown>;
}): Promise<Array<{
    registration: PlatformPackage;
    contribution: PlatformContribution;
}>>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Application root containing installed or acquired artifacts.
`config`	`string`	No	Workspace-relative manifest path; defaults to eaos.platform.json.
`options`	`{ tenantIds?: string[]; bindings?: Record<string, unknown>; }`	No	Host-verified tenantIds for npm modules and in-memory bindings keyed by package identity.

Returns

Promise<Array<{ registration: PlatformPackage; contribution: PlatformContribution; }>>

Loaded registration/contribution pairs in registration order.

Remarks

Executes trusted module top-level code and createExtension. Hosts own authorization and durable bindings; loading is not a tenant activation operation.

Errors and rejections

Rejects missing verified tenants, inventory mismatch, missing createExtension, invalid factory contributions or propagated import/factory errors.

Public members

`options.tenantIds`

Verified concrete tenant catalog required for selected npm modules; no wildcard/default scope is inferred.

`options.bindings`

In-memory live host bindings keyed by package identity and passed to its createExtension factory; not written to registration metadata.

`result[].registration`

Verified package/module registration and its explicit tenant/plugin/settings scope used for loading.

`result[].contribution`

Trusted factory contribution validated to match registration identity, tenant catalog and lifecycle plugin IDs.

Example

import { loadRegisteredPlatformModules } from '@alneas/eaos-cli/platform'
export function loadHost(root: string, tenantIds: string[], bindings: Record<string, unknown>) { return loadRegisteredPlatformModules(root, 'eaos.platform.json', { tenantIds, bindings }) }

[FUNCTION] `loadSiteOperations`

Read siteOperations from the selected application JSON file.

Imports: @alneas/eaos-cli/site.

Signature

declare function loadSiteOperations(root: string, config?: string): Promise<{
    config: SiteOperationsConfig;
    root: string;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Application directory used for path resolution.
`config`	`string`	No	Config path resolved against root; defaults to eaos.platform.json.

Returns

Promise<{ config: SiteOperationsConfig; root: string; }>

The validated site configuration and the configuration file parent directory.

Remarks

Uses ordinary path.resolve; callers must select trusted paths because this loader does not enforce workspace containment.

Errors and rejections

Rejects missing/invalid JSON or invalid siteOperations.

Example

import { loadSiteOperations } from '@alneas/eaos-cli/site'
export function readSites(root: string) { return loadSiteOperations(root) }

[INTERFACE] `LocalSiteOptions`

Cancellation, snapshot and duration controls for one registered local site run.

Imports: @alneas/eaos-cli/site.

Signature

interface LocalSiteOptions {
    snapshot?: string;
    durationSeconds?: number;
    signal?: AbortSignal;
    onReady?: (url: string) => void;
}

Parameters

Name	Type	Required	Description
`snapshot`	`string`	No	Optional snapshot file; must match the registered site and contain a valid revision. Draft snapshots require unexpired preview mode.
`durationSeconds`	`number`	No	Run deadline in seconds, from 1 to 7200; defaults to 600 for build and 1800 for preview.
`signal`	`AbortSignal`	No	Optional cancellation signal; abort terminates the owned process group without undoing arbitrary script side effects.
`onReady`	`(url: string) => void`	No	Optional synchronous notification invoked once with the loopback preview URL after upstream readiness and proxy binding.

Returns

Type declaration; no runtime value.

Public members

`snapshot`

Optional snapshot file; must match the registered site and contain a valid revision. Draft snapshots require unexpired preview mode.

`durationSeconds`

Run deadline in seconds, from 1 to 7200; defaults to 600 for build and 1800 for preview.

`signal`

Optional cancellation signal; abort terminates the owned process group without undoing arbitrary script side effects.

`onReady`

Optional synchronous notification invoked once with the loopback preview URL after upstream readiness and proxy binding.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `LocalSiteProfile`

Host-registered local site, script and remote control bindings.

Imports: @alneas/eaos-cli/site.

Signature

interface LocalSiteProfile {
    id: string;
    name: string;
    cmsSiteId: string;
    directory?: string;
    port?: number;
    buildScript?: string;
    previewScript?: string;
    envKeys?: string[];
    api?: {
        baseUrl: string;
        tokenEnv: string;
    };
    publication?: SitePublicationPolicy;
}

Parameters

Name	Type	Required	Description
`id`	`string`	Yes	Unique registered site key, limited to 1–80 letters, digits, underscores or hyphens.
`name`	`string`	Yes	Nonblank human-readable site label.
`cmsSiteId`	`string`	Yes	CMS site identity required to match a supplied snapshot.
`directory`	`string`	No	Optional absolute trusted local project directory; required for local execution.
`port`	`number`	No	Loopback preview proxy port; defaults to 4321 and reserves the next port for the upstream process.
`buildScript`	`string`	No	Trusted package script name; defaults to build.
`previewScript`	`string`	No	Trusted package preview script name; defaults to dev.
`envKeys`	`string[]`	No	Explicit additional environment variable names forwarded to project scripts; reserved snapshot bindings cannot be selected.
`api`	`{ baseUrl: string; tokenEnv: string; }`	No	Optional HTTPS or loopback control endpoint and the environment variable containing its token.
`publication`	`SitePublicationPolicy`	No	Host-selected site publication policy, validated but not executed during catalog parsing.

Returns

Type declaration; no runtime value.

Public members

`id`

Unique registered site key, limited to 1–80 letters, digits, underscores or hyphens.

`name`

Nonblank human-readable site label.

`cmsSiteId`

CMS site identity required to match a supplied snapshot.

`directory`

Optional absolute trusted local project directory; required for local execution.

`port`

Loopback preview proxy port; defaults to 4321 and reserves the next port for the upstream process.

`buildScript`

Trusted package script name; defaults to build.

`previewScript`

Trusted package preview script name; defaults to dev.

`envKeys`

Explicit additional environment variable names forwarded to project scripts; reserved snapshot bindings cannot be selected.

`api`

Optional HTTPS or loopback control endpoint and the environment variable containing its token.

`api.baseUrl`

Registered HTTPS or loopback HTTP control-service base URL without credentials, query, or fragment; allowlisted paths are appended to it.

`api.tokenEnv`

Uppercase environment-variable name containing the Bearer token read for each control request; a missing/empty value rejects the call.

`publication`

Host-selected site publication policy, validated but not executed during catalog parsing.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `lookupOciAllServicesNetwork`

Look up the regional All Services network and retain its matching route CIDR label.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/lookups.

Signature

declare function lookupOciAllServicesNetwork(options?: pulumi.InvokeOutputOptions): pulumi.Output<OciServiceNetwork>;

Parameters

Name	Type	Required	Description
`options`	`pulumi.InvokeOutputOptions`	No	Optional host-selected Pulumi invoke provider/parent settings.

Returns

pulumi.Output<OciServiceNetwork>

A Pulumi Output with the unique network ID and CIDR label.

Remarks

The host supplies provider region and credentials; no network resource or route is created by this lookup.

Errors and rejections

Provider query errors and absent/ambiguous results reject during Output resolution.

Example

import { lookupOciAllServicesNetwork } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function regionalServices(options: Parameters<typeof lookupOciAllServicesNetwork>[0]) { return lookupOciAllServicesNetwork(options) }

[FUNCTION] `lookupOciImage`

Look up available OCI images and apply an explicit exact-name or latest selection policy.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/lookups.

Signature

declare function lookupOciImage(args: OciImageLookupArgs, options?: pulumi.InvokeOutputOptions): pulumi.Output<string>;

Parameters

Name	Type	Required	Description
`args`	`OciImageLookupArgs`	Yes	Compartment, shape, OS/version and explicit exact/latest selection; exact additionally requires displayName.
`options`	`pulumi.InvokeOutputOptions`	No	Optional host-selected Pulumi invoke provider/parent settings.

Returns

pulumi.Output<string>

A Pulumi Output resolving to the selected image ID.

Remarks

Makes a real provider lookup when used in a host stack; latest can select a newer image on a later update. Pin reviewed IDs where replacement control is required.

Errors and rejections

Invalid immediate selection fails synchronously; provider query, ambiguity and Output selection errors reject during resolution.

Example

import { lookupOciImage } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function reviewedImage(args: Parameters<typeof lookupOciImage>[0]) { return lookupOciImage(args) }

[INTERFACE] `OciAdbConnectionSelection`

Exact provider connection-profile filters; unspecified filters use the documented default TCPS profile.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/database.

Signature

interface OciAdbConnectionSelection {
    consumerGroup?: 'LOW' | 'MEDIUM' | 'HIGH' | 'TP' | 'TPURGENT';
    tlsAuthentication?: 'SERVER' | 'MUTUAL';
    hostFormat?: 'FQDN' | 'IP';
    sessionMode?: 'DIRECT' | 'REDIRECT';
    syntaxFormat?: 'LONG' | 'EZCONNECT' | 'EZCONNECTPLUS';
    isRegional?: boolean;
    displayName?: string;
}

Parameters

Name	Type	Required	Description
`consumerGroup`	`'LOW' \| 'MEDIUM' \| 'HIGH' \| 'TP' \| 'TPURGENT'`	No	Exact provider workload group; selection defaults to LOW.
`tlsAuthentication`	`'SERVER' \| 'MUTUAL'`	No	Exact provider TLS authentication mode; selection defaults to SERVER.
`hostFormat`	`'FQDN' \| 'IP'`	No	Exact provider hostname representation; selection defaults to FQDN.
`sessionMode`	`'DIRECT' \| 'REDIRECT'`	No	Optional exact DIRECT/REDIRECT filter; omission leaves both eligible.
`syntaxFormat`	`'LONG' \| 'EZCONNECT' \| 'EZCONNECTPLUS'`	No	Provider DSN syntax; selection defaults to LONG.
`isRegional`	`boolean`	No	Optional exact regional-profile flag; omitted value does not filter it.
`displayName`	`string`	No	Optional exact display-name filter; omission does not filter profile display names.

Returns

Type declaration; no runtime value.

Public members

`consumerGroup`

Exact provider workload group; selection defaults to LOW.

`tlsAuthentication`

Exact provider TLS authentication mode; selection defaults to SERVER.

`hostFormat`

Exact provider hostname representation; selection defaults to FQDN.

`sessionMode`

Optional exact DIRECT/REDIRECT filter; omission leaves both eligible.

`syntaxFormat`

Provider DSN syntax; selection defaults to LONG.

`isRegional`

Optional exact regional-profile flag; omitted value does not filter it.

`displayName`

Optional exact display-name filter; omission does not filter profile display names.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciAdbPresetArgs`

Explicit host inputs for declaring the OCI edge/worker, database and storage preset.

Imports: @alneas/eaos-cli/presets/oci-adb.

Signature

interface OciAdbPresetArgs {
    compartmentId: pulumi.Input<string>;
    availabilityDomain: pulumi.Input<string>;
    edgeImageId: pulumi.Input<string>;
    workerImageId: pulumi.Input<string>;
    sshAuthorizedKeys: pulumi.Input<string>;
    sshCidr: string;
    dbName: pulumi.Input<string>;
    dbVersion: pulumi.Input<string>;
    adminPassword: pulumi.Input<string>;
    objectStorageNamespace: pulumi.Input<string>;
    workerShape?: pulumi.Input<string>;
    workerShapeConfig?: oci.core.InstanceArgs['shapeConfig'];
}

Parameters

Name	Type	Required	Description
`compartmentId`	`pulumi.Input<string>`	Yes	Host-selected OCI compartment for preset resources.
`availabilityDomain`	`pulumi.Input<string>`	Yes	Reviewed availability domain for edge/worker Compute.
`edgeImageId`	`pulumi.Input<string>`	Yes	Reviewed image ID compatible with the edge host architecture.
`workerImageId`	`pulumi.Input<string>`	Yes	Reviewed image ID compatible with the worker host architecture.
`sshAuthorizedKeys`	`pulumi.Input<string>`	Yes	Host-authorized SSH public keys for newly declared instances.
`sshCidr`	`string`	Yes	Explicit restricted IPv4 client CIDR; /0 is rejected.
`dbName`	`pulumi.Input<string>`	Yes	Explicit database name selected by the host.
`dbVersion`	`pulumi.Input<string>`	Yes	Supported database version selected explicitly by the host.
`adminPassword`	`pulumi.Input<string>`	Yes	Sensitive database administrator password Input; preserve Pulumi secrecy.
`objectStorageNamespace`	`pulumi.Input<string>`	Yes	OCI Object Storage namespace selected by the host.
`workerShape`	`pulumi.Input<string>`	No	Optional worker shape; defaults to VM.Standard.A1.Flex.
`workerShapeConfig`	`oci.core.InstanceArgs['shapeConfig']`	No	Optional worker resources; defaults to 2 OCPUs and 12 GiB memory.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

Host-selected OCI compartment for preset resources.

`availabilityDomain`

Reviewed availability domain for edge/worker Compute.

`edgeImageId`

Reviewed image ID compatible with the edge host architecture.

`workerImageId`

Reviewed image ID compatible with the worker host architecture.

`sshAuthorizedKeys`

Host-authorized SSH public keys for newly declared instances.

`sshCidr`

Explicit restricted IPv4 client CIDR; /0 is rejected.

`dbName`

Explicit database name selected by the host.

`dbVersion`

Supported database version selected explicitly by the host.

`adminPassword`

Sensitive database administrator password Input; preserve Pulumi secrecy.

`objectStorageNamespace`

OCI Object Storage namespace selected by the host.

`workerShape`

Optional worker shape; defaults to VM.Standard.A1.Flex.

`workerShapeConfig`

Optional worker resources; defaults to 2 OCPUs and 12 GiB memory.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciAuthTokenArgs`

User identity and description for creation of an OCI registry authentication token.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/vault.

Signature

interface OciAuthTokenArgs {
    userId: pulumi.Input<string>;
    description?: pulumi.Input<string>;
    authToken?: Partial<oci.identity.AuthTokenArgs>;
}

Parameters

Name	Type	Required	Description
`userId`	`pulumi.Input<string>`	Yes	Existing OCI user identity for which an authentication token is declared.
`description`	`pulumi.Input<string>`	No	Provider-visible description; defaults to AuthToken for followed by the factory’s logical name, unless native authToken overrides replace it.
`authToken`	`Partial<oci.identity.AuthTokenArgs>`	No	Shallow native AuthToken arguments applied last.

Returns

Type declaration; no runtime value.

Public members

`userId`

Existing OCI user identity for which an authentication token is declared.

`description`

Provider-visible description; defaults to AuthToken for followed by the factory’s logical name, unless native authToken overrides replace it.

`authToken`

Shallow native AuthToken arguments applied last.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[TYPE] `OciAutonomousDatabaseArgs`

Either the explicit new free-oltp database profile or complete native arguments with defaults disabled.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/database.

Signature

type OciAutonomousDatabaseArgs = {
    defaults?: 'free-oltp';
    compartmentId: pulumi.Input<string>;
    dbName: pulumi.Input<string>;
    dbVersion: pulumi.Input<string>;
    adminPassword: pulumi.Input<string>;
    whitelistedIps: NonNullable<oci.database.AutonomousDatabaseArgs['whitelistedIps']>;
    database?: Partial<oci.database.AutonomousDatabaseArgs>;
} | {
    defaults: 'none';
    database: oci.database.AutonomousDatabaseArgs;
};

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Type declaration; no runtime value.

Public members

`defaults`

Omitted or free-oltp selects the new-database defaults; protection defaults on but host resource options can override it.

`compartmentId`

OCI compartment ID supplied through the host provider context.

`dbName`

Database name selected by the trusted host.

`dbVersion`

Required explicit provider-supported Oracle database version for the new-database profile.

`adminPassword`

Sensitive administrator password Input; the factory wraps it as a Pulumi secret.

`whitelistedIps`

Explicit nonempty endpoint ACL of IP/CIDR or supported VCN references; no world-open default is inferred.

`database`

Native OCI Autonomous Database arguments/overrides; defaults=none requires the complete native shape.

`defaults`

Select none to require complete native database arguments and skip the free-oltp defaults and default resource protection.

`database`

Native OCI Autonomous Database arguments/overrides; defaults=none requires the complete native shape.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciBastionArgs`

Bastion subnet and explicit client CIDR allowlist with optional native overrides.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/access.

Signature

interface OciBastionArgs {
    compartmentId: pulumi.Input<string>;
    targetSubnetId: pulumi.Input<string>;
    clientCidrBlockAllowLists: NonNullable<oci.bastion.BastionArgs['clientCidrBlockAllowLists']>;
    maxSessionTtlInSeconds?: pulumi.Input<number>;
    bastion?: Partial<oci.bastion.BastionArgs>;
}

Parameters

Name	Type	Required	Description
`compartmentId`	`pulumi.Input<string>`	Yes	OCI compartment ID supplied through the host provider context.
`targetSubnetId`	`pulumi.Input<string>`	Yes	Host-selected private target subnet ID for the Bastion service.
`clientCidrBlockAllowLists`	`NonNullable<oci.bastion.BastionArgs['clientCidrBlockAllowLists']>`	Yes	Explicit nonempty source CIDR allowlist for Bastion clients; no public default is provided.
`maxSessionTtlInSeconds`	`pulumi.Input<number>`	No	Optional Bastion session TTL in seconds; defaults to 10800.
`bastion`	`Partial<oci.bastion.BastionArgs>`	No	Shallow native Bastion arguments applied last, replacing nested defaults.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

OCI compartment ID supplied through the host provider context.

`targetSubnetId`

Host-selected private target subnet ID for the Bastion service.

`clientCidrBlockAllowLists`

Explicit nonempty source CIDR allowlist for Bastion clients; no public default is provided.

`maxSessionTtlInSeconds`

Optional Bastion session TTL in seconds; defaults to 10800.

`bastion`

Shallow native Bastion arguments applied last, replacing nested defaults.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciComputeArgs`

Reviewed image, subnet and instance/bootstrap customization for one OCI host.

Imports: @alneas/eaos-cli/presets/oci-adb/infra.

Signature

interface OciComputeArgs {
    compartmentId: pulumi.Input<string>;
    availabilityDomain: pulumi.Input<string>;
    subnetId: pulumi.Input<string>;
    imageId: pulumi.Input<string>;
    shape?: pulumi.Input<string>;
    shapeConfig?: oci.core.InstanceArgs['shapeConfig'];
    sshAuthorizedKeys?: pulumi.Input<string>;
    bootVolumeSizeInGbs?: pulumi.Input<string>;
    bootstrap?: {
        containerRuntime?: 'docker' | 'none';
    };
    instance?: Partial<oci.core.InstanceArgs>;
}

Parameters

Name	Type	Required	Description
`compartmentId`	`pulumi.Input<string>`	Yes	OCI compartment ID supplied through the host provider context.
`availabilityDomain`	`pulumi.Input<string>`	Yes	Reviewed OCI availability domain for the selected resource.
`subnetId`	`pulumi.Input<string>`	Yes	Explicit subnet ID/Input selected by the host.
`imageId`	`pulumi.Input<string>`	Yes	Explicit reviewed image ID; the factory does not perform a newest-image lookup.
`shape`	`pulumi.Input<string>`	No	Optional host-selected OCI instance shape.
`shapeConfig`	`oci.core.InstanceArgs['shapeConfig']`	No	Optional shape resource allocation; provider shape compatibility remains host-owned.
`sshAuthorizedKeys`	`pulumi.Input<string>`	No	SSH public keys admitted by the host; never a private key.
`bootVolumeSizeInGbs`	`pulumi.Input<string>`	No	Boot volume size in GiB as an OCI string Input; defaults to 50.
`bootstrap`	`{ containerRuntime?: 'docker' \| 'none'; }`	No	Optional first-boot container runtime selection; generated Docker cloud-init is disabled by none.
`instance`	`Partial<oci.core.InstanceArgs>`	No	Shallow native OCI Instance overrides applied after host defaults; nested metadata/source details follow the factory merge policy.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

OCI compartment ID supplied through the host provider context.

`availabilityDomain`

Reviewed OCI availability domain for the selected resource.

`subnetId`

Explicit subnet ID/Input selected by the host.

`imageId`

Explicit reviewed image ID; the factory does not perform a newest-image lookup.

`shape`

Optional host-selected OCI instance shape.

`shapeConfig`

Optional shape resource allocation; provider shape compatibility remains host-owned.

`sshAuthorizedKeys`

SSH public keys admitted by the host; never a private key.

`bootVolumeSizeInGbs`

Boot volume size in GiB as an OCI string Input; defaults to 50.

`bootstrap`

Optional first-boot container runtime selection; generated Docker cloud-init is disabled by none.

`bootstrap.containerRuntime`

Defaults to Docker cloud-init; none suppresses the generated Docker user_data, while explicit native metadata may still supply host bootstrap code.

`instance`

Shallow native OCI Instance overrides applied after host defaults; nested metadata/source details follow the factory merge policy.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[TYPE] `OciImageLookupArgs`

Available image query with a mandatory exact-name or latest selection decision.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/lookups.

Signature

type OciImageLookupArgs = {
    compartmentId: pulumi.Input<string>;
    shape: pulumi.Input<string>;
    operatingSystem: pulumi.Input<string>;
    operatingSystemVersion: pulumi.Input<string>;
} & ({
    selection: 'exact';
    displayName: pulumi.Input<string>;
} | {
    selection: 'latest';
    displayName?: never;
});

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

OCI compartment ID supplied through the host provider context.

`shape`

Required host-reviewed instance shape used to filter compatible images.

`operatingSystem`

Host-reviewed OCI image operating-system name.

`operatingSystemVersion`

Host-reviewed OCI image operating-system release.

`selection`

Explicit selection policy: exact requires one matching displayName; latest chooses newest creation time with ascending ID as a deterministic tie-breaker.

`displayName`

Exact provider display name required for exact selection; the latest variant forbids this property.

`selection`

Explicit selection policy: exact requires one matching displayName; latest chooses newest creation time with ascending ID as a deterministic tie-breaker.

`displayName`

Exact provider display name required for exact selection; the latest variant forbids this property.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciNetworkArgs`

Compartment, CIDR ranges and explicit ingress for the simple public-network factory.

Imports: @alneas/eaos-cli/presets/oci-adb/infra.

Signature

interface OciNetworkArgs {
    compartmentId: pulumi.Input<string>;
    cidrBlock?: pulumi.Input<string>;
    subnetCidrBlock?: pulumi.Input<string>;
    ingress?: oci.core.SecurityListArgs['ingressSecurityRules'];
}

Parameters

Name	Type	Required	Description
`compartmentId`	`pulumi.Input<string>`	Yes	OCI compartment ID supplied through the host provider context.
`cidrBlock`	`pulumi.Input<string>`	No	VCN address range; defaults to 10.0.0.0/16.
`subnetCidrBlock`	`pulumi.Input<string>`	No	Optional simple public subnet range; defaults to 10.0.1.0/24.
`ingress`	`oci.core.SecurityListArgs['ingressSecurityRules']`	No	Explicit ingress rules; the simple network has no inbound rules when omitted.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

OCI compartment ID supplied through the host provider context.

`cidrBlock`

VCN address range; defaults to 10.0.0.0/16.

`subnetCidrBlock`

Optional simple public subnet range; defaults to 10.0.1.0/24.

`ingress`

Explicit ingress rules; the simple network has no inbound rules when omitted.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciNetworkCustomizations`

Per-resource native overrides for the two-subnet OCI network.

Imports: @alneas/eaos-cli/presets/oci-adb/infra.

Signature

interface OciNetworkCustomizations {
    vcn?: OciResourceCustomization<oci.core.VcnArgs>;
    dhcpOptions?: OciResourceCustomization<oci.core.DhcpOptionsArgs>;
    internetGateway?: OciResourceCustomization<oci.core.InternetGatewayArgs>;
    natGateway?: OciResourceCustomization<oci.core.NatGatewayArgs>;
    serviceGateway?: OciResourceCustomization<oci.core.ServiceGatewayArgs>;
    publicRoutes?: OciResourceCustomization<oci.core.RouteTableArgs>;
    privateRoutes?: OciResourceCustomization<oci.core.RouteTableArgs>;
    publicSecurityList?: OciResourceCustomization<oci.core.SecurityListArgs>;
    privateSecurityList?: OciResourceCustomization<oci.core.SecurityListArgs>;
    publicSubnet?: OciResourceCustomization<oci.core.SubnetArgs>;
    privateSubnet?: OciResourceCustomization<oci.core.SubnetArgs>;
}

Parameters

Name	Type	Required	Description
`vcn`	`OciResourceCustomization<oci.core.VcnArgs>`	No	Optional VCN logical name, shallow arguments and resource option overrides.
`dhcpOptions`	`OciResourceCustomization<oci.core.DhcpOptionsArgs>`	No	Optional DHCP resource logical name, shallow arguments and resource option overrides.
`internetGateway`	`OciResourceCustomization<oci.core.InternetGatewayArgs>`	No	Optional internet gateway logical name, shallow arguments and resource option overrides.
`natGateway`	`OciResourceCustomization<oci.core.NatGatewayArgs>`	No	Optional NAT gateway logical name, shallow arguments and resource option overrides.
`serviceGateway`	`OciResourceCustomization<oci.core.ServiceGatewayArgs>`	No	Optional service gateway logical name, shallow arguments and resource option overrides.
`publicRoutes`	`OciResourceCustomization<oci.core.RouteTableArgs>`	No	Optional public route-table overrides; nested route arrays are replaced, not merged.
`privateRoutes`	`OciResourceCustomization<oci.core.RouteTableArgs>`	No	Optional private route-table overrides; nested route arrays are replaced, not merged.
`publicSecurityList`	`OciResourceCustomization<oci.core.SecurityListArgs>`	No	Optional public security-list overrides; replaced rules need independent review.
`privateSecurityList`	`OciResourceCustomization<oci.core.SecurityListArgs>`	No	Optional private security-list overrides; replaced rules need independent review.
`publicSubnet`	`OciResourceCustomization<oci.core.SubnetArgs>`	No	Optional public subnet logical name, shallow arguments and resource option overrides.
`privateSubnet`	`OciResourceCustomization<oci.core.SubnetArgs>`	No	Optional private subnet logical name, shallow arguments and resource option overrides.

Returns

Type declaration; no runtime value.

Public members

`vcn`

Optional VCN logical name, shallow arguments and resource option overrides.

`dhcpOptions`

Optional DHCP resource logical name, shallow arguments and resource option overrides.

`internetGateway`

Optional internet gateway logical name, shallow arguments and resource option overrides.

`natGateway`

Optional NAT gateway logical name, shallow arguments and resource option overrides.

`serviceGateway`

Optional service gateway logical name, shallow arguments and resource option overrides.

`publicRoutes`

Optional public route-table overrides; nested route arrays are replaced, not merged.

`privateRoutes`

Optional private route-table overrides; nested route arrays are replaced, not merged.

`publicSecurityList`

Optional public security-list overrides; replaced rules need independent review.

`privateSecurityList`

Optional private security-list overrides; replaced rules need independent review.

`publicSubnet`

Optional public subnet logical name, shallow arguments and resource option overrides.

`privateSubnet`

Optional private subnet logical name, shallow arguments and resource option overrides.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciNetworkLoadBalancerArgs`

Explicit subnet/target and optional listener/native customization for TCP NLB forwarding.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/access.

Signature

interface OciNetworkLoadBalancerArgs {
    compartmentId: pulumi.Input<string>;
    subnetId: pulumi.Input<string>;
    targetId: pulumi.Input<string>;
    listeners?: readonly OciNlbListenerConfig[];
    loadBalancer?: OciResourceCustomization<oci.networkloadbalancer.NetworkLoadBalancerArgs>;
}

Parameters

Name	Type	Required	Description
`compartmentId`	`pulumi.Input<string>`	Yes	OCI compartment ID supplied through the host provider context.
`subnetId`	`pulumi.Input<string>`	Yes	Explicit subnet ID/Input selected by the host.
`targetId`	`pulumi.Input<string>`	Yes	Compute/private-IP resource target; one backend is registered per listener.
`listeners`	`readonly OciNlbListenerConfig[]`	No	Optional nonempty unique listener selections; defaults to TCP 80 and 443.
`loadBalancer`	`OciResourceCustomization<oci.networkloadbalancer.NetworkLoadBalancerArgs>`	No	Optional native NLB logical name, shallow arguments and resource option overrides.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

OCI compartment ID supplied through the host provider context.

`subnetId`

Explicit subnet ID/Input selected by the host.

`targetId`

Compute/private-IP resource target; one backend is registered per listener.

`listeners`

Optional nonempty unique listener selections; defaults to TCP 80 and 443.

`loadBalancer`

Optional native NLB logical name, shallow arguments and resource option overrides.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciNlbIngressRulesOptions`

Port and client-CIDR combinations to render as backend TCP ingress rules.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/access.

Signature

interface OciNlbIngressRulesOptions {
    ports?: number[];
    allowedCidrs?: string[];
    descriptionPrefix?: string;
}

Parameters

Name	Type	Required	Description
`ports`	`number[]`	No	Target TCP ports; defaults to 80 and 443. This rendering helper does not validate them.
`allowedCidrs`	`string[]`	No	Client source CIDRs; defaults to 0.0.0.0/0. Review actual load-balancer source handling before adopting rules.
`descriptionPrefix`	`string`	No	Rule label prefix; defaults to NLB backend.

Returns

Type declaration; no runtime value.

Public members

`ports`

Target TCP ports; defaults to 80 and 443. This rendering helper does not validate them.

`allowedCidrs`

Client source CIDRs; defaults to 0.0.0.0/0. Review actual load-balancer source handling before adopting rules.

`descriptionPrefix`

Rule label prefix; defaults to NLB backend.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciNlbListenerConfig`

One uniquely keyed TCP listener with its backend port, health check and optional resource overrides.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/access.

Signature

interface OciNlbListenerConfig {
    key: string;
    port: number;
    backendPort?: number;
    healthChecker?: oci.networkloadbalancer.BackendSetArgs['healthChecker'];
    resources?: {
        backendSet?: OciResourceCustomization<oci.networkloadbalancer.BackendSetArgs>;
        backend?: OciResourceCustomization<oci.networkloadbalancer.BackendArgs>;
        listener?: OciResourceCustomization<oci.networkloadbalancer.ListenerArgs>;
    };
}

Parameters

Name	Type	Required	Description
`key`	`string`	Yes	Stable unique lowercase listener key used for child resource names.
`port`	`number`	Yes	Unique integer listener port from 1 to 65535.
`backendPort`	`number`	No	Optional backend port; defaults to the listener port.
`healthChecker`	`oci.networkloadbalancer.BackendSetArgs['healthChecker']`	No	Optional native health-check configuration; defaults to TCP on the backend port.
`resources`	`{ backendSet?: OciResourceCustomization<oci.networkloadbalancer.BackendSetArgs>; backend?: OciResourceCustomization<oci.networkloadbalancer.BackendArgs>; listener?: OciResourceCustomization<oci.networkloadbalancer.ListenerArgs>; }`	No	Per-child shallow native overrides; review replaced nested arguments and resource options.

Returns

Type declaration; no runtime value.

Public members

`key`

Stable unique lowercase listener key used for child resource names.

`port`

Unique integer listener port from 1 to 65535.

`backendPort`

Optional backend port; defaults to the listener port.

`healthChecker`

Optional native health-check configuration; defaults to TCP on the backend port.

`resources`

Per-child shallow native overrides; review replaced nested arguments and resource options.

`resources.backendSet`

Optional logical name, shallow native arguments, and resource options overriding this listener’s backend set and health-check defaults.

`resources.backend`

Optional logical name, shallow native arguments, and resource options overriding the listener target/backend-port resource.

`resources.listener`

Optional logical name, shallow native arguments, and resource options overriding the TCP listener resource.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciNlbListenerResources`

Native resources registered for one load-balancer listener key.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/access.

Signature

interface OciNlbListenerResources {
    backendSet: oci.networkloadbalancer.BackendSet;
    backend: oci.networkloadbalancer.Backend;
    listener: oci.networkloadbalancer.Listener;
}

Parameters

Name	Type	Required	Description
`backendSet`	`oci.networkloadbalancer.BackendSet`	Yes	Native backend-set resource registered for this listener, with its configured health checker and routing policy.
`backend`	`oci.networkloadbalancer.Backend`	Yes	Native backend resource binding the selected target and backend port.
`listener`	`oci.networkloadbalancer.Listener`	Yes	Native TCP listener resource forwarding its port to this backend set.

Returns

Type declaration; no runtime value.

Public members

`backendSet`

Native backend-set resource registered for this listener, with its configured health checker and routing policy.

`backend`

Native backend resource binding the selected target and backend port.

`listener`

Native TCP listener resource forwarding its port to this backend set.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciPrivateNetworkArgs`

Host network ranges, security rules and optional regional service-network routing.

Imports: @alneas/eaos-cli/presets/oci-adb/infra.

Signature

interface OciPrivateNetworkArgs {
    compartmentId: pulumi.Input<string>;
    resourceCompartmentId?: pulumi.Input<string>;
    cidrBlock?: pulumi.Input<string>;
    publicSubnetCidrBlock?: pulumi.Input<string>;
    privateSubnetCidrBlock?: pulumi.Input<string>;
    vcnDnsLabel?: pulumi.Input<string>;
    publicIngress?: oci.core.SecurityListArgs['ingressSecurityRules'];
    privateIngress?: oci.core.SecurityListArgs['ingressSecurityRules'];
    serviceNetwork?: pulumi.Input<OciServiceNetwork>;
    resources?: OciNetworkCustomizations;
}

Parameters

Name	Type	Required	Description
`compartmentId`	`pulumi.Input<string>`	Yes	OCI compartment ID supplied through the host provider context.
`resourceCompartmentId`	`pulumi.Input<string>`	No	Optional separate compartment for network children; defaults to the VCN compartment.
`cidrBlock`	`pulumi.Input<string>`	No	VCN address range; defaults to 10.0.0.0/16 before native VCN overrides.
`publicSubnetCidrBlock`	`pulumi.Input<string>`	No	Optional public subnet range; defaults to 10.0.0.0/24.
`privateSubnetCidrBlock`	`pulumi.Input<string>`	No	Optional private subnet range; defaults to 10.0.1.0/24.
`vcnDnsLabel`	`pulumi.Input<string>`	No	Optional DNS label used by the VCN declaration.
`publicIngress`	`oci.core.SecurityListArgs['ingressSecurityRules']`	No	Explicit ingress rules attached to the public subnet security list.
`privateIngress`	`oci.core.SecurityListArgs['ingressSecurityRules']`	No	Explicit ingress rules attached to the private subnet security list.
`serviceNetwork`	`pulumi.Input<OciServiceNetwork>`	No	Optional reviewed Oracle service-network ID/CIDR pair; omission means no implicit provider lookup or service route.
`resources`	`OciNetworkCustomizations`	No	Per-child shallow native overrides; review replaced nested arguments and resource options.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

OCI compartment ID supplied through the host provider context.

`resourceCompartmentId`

Optional separate compartment for network children; defaults to the VCN compartment.

`cidrBlock`

VCN address range; defaults to 10.0.0.0/16 before native VCN overrides.

`publicSubnetCidrBlock`

Optional public subnet range; defaults to 10.0.0.0/24.

`privateSubnetCidrBlock`

Optional private subnet range; defaults to 10.0.1.0/24.

`vcnDnsLabel`

Optional DNS label used by the VCN declaration.

`publicIngress`

Explicit ingress rules attached to the public subnet security list.

`privateIngress`

Explicit ingress rules attached to the private subnet security list.

`serviceNetwork`

Optional reviewed Oracle service-network ID/CIDR pair; omission means no implicit provider lookup or service route.

`resources`

Per-child shallow native overrides; review replaced nested arguments and resource options.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciResourceCustomization`

Shallow native resource overrides applied after the preset defaults.

Imports: @alneas/eaos-cli/presets/oci-adb/infra.

Signature

interface OciResourceCustomization<T> {
    name?: string;
    args?: Partial<T>;
    options?: pulumi.CustomResourceOptions;
}

Parameters

Name	Type	Required	Description
`name`	`string`	No	Optional replacement logical resource name; omission keeps the factory default.
`args`	`Partial<T>`	No	Shallow native argument overrides; nested objects and arrays replace the default values.
`options`	`pulumi.CustomResourceOptions`	No	Optional native Pulumi resource options, merged after parent defaults.

Returns

Type declaration; no runtime value.

Type parameters

T: Native provider argument shape whose selected top-level fields may be replaced by the host.

Public members

`name`

Optional replacement logical resource name; omission keeps the factory default.

`args`

Shallow native argument overrides; nested objects and arrays replace the default values.

`options`

Optional native Pulumi resource options, merged after parent defaults.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciServiceNetwork`

Matching regional Oracle service-network resource identity and route CIDR label.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/lookups.

Signature

interface OciServiceNetwork {
    id: string;
    cidrBlock: string;
}

Parameters

Name	Type	Required	Description
`id`	`string`	Yes	Provider identity of the selected regional All Services network.
`cidrBlock`	`string`	Yes	Regional service-network route CIDR label returned with that same provider identity.

Returns

Type declaration; no runtime value.

Public members

`id`

Provider identity of the selected regional All Services network.

`cidrBlock`

Regional service-network route CIDR label returned with that same provider identity.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciVaultArgs`

KMS Vault compartment, display and type settings with shallow native overrides.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/vault.

Signature

interface OciVaultArgs {
    compartmentId: pulumi.Input<string>;
    displayName?: pulumi.Input<string>;
    vaultType?: pulumi.Input<'DEFAULT' | 'VIRTUAL_PRIVATE'>;
    vault?: Partial<oci.kms.VaultArgs>;
}

Parameters

Name	Type	Required	Description
`compartmentId`	`pulumi.Input<string>`	Yes	OCI compartment ID supplied through the host provider context.
`displayName`	`pulumi.Input<string>`	No	Optional provider display name; defaults to the factory’s logical resource name unless native vault overrides replace it.
`vaultType`	`pulumi.Input<'DEFAULT' \| 'VIRTUAL_PRIVATE'>`	No	Optional DEFAULT or VIRTUAL_PRIVATE Vault kind; defaults to DEFAULT.
`vault`	`Partial<oci.kms.VaultArgs>`	No	Shallow native KMS Vault arguments applied last.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

OCI compartment ID supplied through the host provider context.

`displayName`

Optional provider display name; defaults to the factory’s logical resource name unless native vault overrides replace it.

`vaultType`

Optional DEFAULT or VIRTUAL_PRIVATE Vault kind; defaults to DEFAULT.

`vault`

Shallow native KMS Vault arguments applied last.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciVaultKeyArgs`

Vault management endpoint and encryption key settings with shallow native overrides.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/vault.

Signature

interface OciVaultKeyArgs {
    compartmentId: pulumi.Input<string>;
    managementEndpoint: pulumi.Input<string>;
    displayName?: pulumi.Input<string>;
    algorithm?: 'AES' | 'RSA' | 'ECDSA';
    length?: number;
    protectionMode?: 'SOFTWARE' | 'HSM';
    key?: Partial<oci.kms.KeyArgs>;
}

Parameters

Name	Type	Required	Description
`compartmentId`	`pulumi.Input<string>`	Yes	OCI compartment ID supplied through the host provider context.
`managementEndpoint`	`pulumi.Input<string>`	Yes	Vault management endpoint Input supplied by the selected provider resource.
`displayName`	`pulumi.Input<string>`	No	Optional provider display name; defaults to the factory’s logical resource name unless native key overrides replace it.
`algorithm`	`'AES' \| 'RSA' \| 'ECDSA'`	No	Key algorithm; defaults to AES. Supply a provider-compatible explicit length when selecting another algorithm.
`length`	`number`	No	Key length in provider units; current implementation defaults to 32 for every algorithm.
`protectionMode`	`'SOFTWARE' \| 'HSM'`	No	SOFTWARE by default, or explicitly selected HSM protection.
`key`	`Partial<oci.kms.KeyArgs>`	No	Shallow native KMS Key arguments applied last; nested keyShape values are replaced.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

OCI compartment ID supplied through the host provider context.

`managementEndpoint`

Vault management endpoint Input supplied by the selected provider resource.

`displayName`

Optional provider display name; defaults to the factory’s logical resource name unless native key overrides replace it.

`algorithm`

Key algorithm; defaults to AES. Supply a provider-compatible explicit length when selecting another algorithm.

`length`

Key length in provider units; current implementation defaults to 32 for every algorithm.

`protectionMode`

SOFTWARE by default, or explicitly selected HSM protection.

`key`

Shallow native KMS Key arguments applied last; nested keyShape values are replaced.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OciVaultSecretArgs`

Vault/key destination and secret-wrapped content used for an OCI secret declaration.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/vault.

Signature

interface OciVaultSecretArgs {
    compartmentId: pulumi.Input<string>;
    vaultId: pulumi.Input<string>;
    keyId: pulumi.Input<string>;
    secretName: pulumi.Input<string>;
    description?: pulumi.Input<string>;
    secretContent: pulumi.Input<string>;
    isAlreadyBase64?: boolean;
    secret?: Partial<oci.vault.SecretArgs>;
}

Parameters

Name	Type	Required	Description
`compartmentId`	`pulumi.Input<string>`	Yes	OCI compartment ID supplied through the host provider context.
`vaultId`	`pulumi.Input<string>`	Yes	Explicit Vault identity for secret storage.
`keyId`	`pulumi.Input<string>`	Yes	Explicit KMS key identity used to encrypt the secret.
`secretName`	`pulumi.Input<string>`	Yes	Provider-visible secret name selected by the host.
`description`	`pulumi.Input<string>`	No	Provider-visible description; defaults to Encrypted Secret for followed by the factory’s logical name, unless native secret overrides replace it.
`secretContent`	`pulumi.Input<string>`	Yes	Sensitive raw UTF-8 or already-base64 Input; wrapped as a secret before conversion.
`isAlreadyBase64`	`boolean`	No	False by default; true preserves supplied base64 bytes without encoding them again.
`secret`	`Partial<oci.vault.SecretArgs>`	No	Shallow native secret arguments applied last; overriding secretContent requires reviewing secrecy independently.

Returns

Type declaration; no runtime value.

Public members

`compartmentId`

OCI compartment ID supplied through the host provider context.

`vaultId`

Explicit Vault identity for secret storage.

`keyId`

Explicit KMS key identity used to encrypt the secret.

`secretName`

Provider-visible secret name selected by the host.

`description`

Provider-visible description; defaults to Encrypted Secret for followed by the factory’s logical name, unless native secret overrides replace it.

`secretContent`

Sensitive raw UTF-8 or already-base64 Input; wrapped as a secret before conversion.

`isAlreadyBase64`

False by default; true preserves supplied base64 bytes without encoding them again.

`secret`

Shallow native secret arguments applied last; overriding secretContent requires reviewing secrecy independently.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OperationPorts`

Explicit test or host overrides for operations, commands, deployment and HTTP verification.

Imports: @alneas/eaos-cli/platform/operations.

Signature

interface OperationPorts {
    operations?: PlatformOperations;
    run?: OperationRunner;
    deploy?: typeof deployPlatformImage;
    fetch?: typeof globalThis.fetch;
}

Parameters

Name	Type	Required	Description
`operations`	`PlatformOperations`	No	Explicit trusted host operations; omitted value loads the configured live operation module.
`run`	`OperationRunner`	No	Optional argv-only subprocess port; omitted value invokes the real host runner.
`deploy`	`typeof deployPlatformImage`	No	Optional image-deployment port; omitted value uses real Kamal/OpenSSH deployment.
`fetch`	`typeof globalThis.fetch`	No	Optional HTTP readiness port; omitted value uses global fetch.

Returns

Type declaration; no runtime value.

Public members

`operations`

Explicit trusted host operations; omitted value loads the configured live operation module.

`run`

Optional argv-only subprocess port; omitted value invokes the real host runner.

`deploy`

Optional image-deployment port; omitted value uses real Kamal/OpenSSH deployment.

`fetch`

Optional HTTP readiness port; omitted value uses global fetch.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `OperationReceipt`

Persisted release/bootstrap execution state and lifecycle plan hashes.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/operations.

Signature

interface OperationReceipt {
    formatVersion: 1;
    id: string;
    operation: 'release' | 'bootstrap';
    inputSha256: string;
    environment: string;
    startedAt: string;
    finishedAt?: string;
    status: 'running' | 'succeeded' | 'failed';
    stages: Array<{
        name: string;
        status: 'running' | 'succeeded' | 'failed';
        startedAt: string;
        finishedAt?: string;
    }>;
    lifecyclePlans: string[];
}

Parameters

Name	Type	Required	Description
`formatVersion`	`1`	Yes	Persisted operation receipt format; currently 1.
`id`	`string`	Yes	Unique execution UUID matching the release context.
`operation`	`'release' \| 'bootstrap'`	Yes	Requested release or bootstrap operation.
`inputSha256`	`string`	Yes	Hash of inputs used for the reviewed operation.
`environment`	`string`	Yes	Shared host environment identity supplied by trusted operations.
`startedAt`	`string`	Yes	UTC ISO timestamp for operation start.
`finishedAt`	`string`	No	UTC ISO timestamp set when the attempt finishes.
`status`	`'running' \| 'succeeded' \| 'failed'`	Yes	Current running, succeeded or failed outcome.
`stages`	`Array<{ name: string; status: 'running' \| 'succeeded' \| 'failed'; startedAt: string; finishedAt?: string; }>`	Yes	Ordered per-stage status records; a failed attempt preserves completed and failed stages.
`lifecyclePlans`	`string[]`	Yes	Lifecycle plan hashes used by this attempt for later review.

Returns

Type declaration; no runtime value.

Public members

`formatVersion`

Persisted operation receipt format; currently 1.

`id`

Unique execution UUID matching the release context.

`operation`

Requested release or bootstrap operation.

`inputSha256`

Hash of inputs used for the reviewed operation.

`environment`

Shared host environment identity supplied by trusted operations.

`startedAt`

UTC ISO timestamp for operation start.

`finishedAt`

UTC ISO timestamp set when the attempt finishes.

`status`

Current running, succeeded or failed outcome.

`stages`

Ordered per-stage status records; a failed attempt preserves completed and failed stages.

`stages[].name`

Execution stage label, such as migrate or deploy:backend.

`stages[].status`

Stage outcome; running can remain in evidence after interruption.

`stages[].startedAt`

ISO start time written before stage work.

`stages[].finishedAt`

ISO completion time when the stage’s finally block executes.

`lifecyclePlans`

Lifecycle plan hashes used by this attempt for later review.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[TYPE] `OperationRunner`

Trusted argv-only executable runner used by host operations; it is not an OS sandbox.

Imports: @alneas/eaos-cli/platform/operations.

Signature

type OperationRunner = (command: string, argv: string[], options: {
    cwd: string;
    env?: NodeJS.ProcessEnv;
}) => Promise<void>;

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Type declaration; no runtime value.

Public members

`options.cwd`

Trusted working directory for the argv-only subprocess invocation.

`options.env`

Optional explicit subprocess environment; when omitted, the real runner inherits its process environment.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `parseSiteOperationsConfig`

Validate the registered local-site catalog and return an independent copy.

Imports: @alneas/eaos-cli/site.

Signature

declare function parseSiteOperationsConfig(input: unknown): SiteOperationsConfig;

Parameters

Name	Type	Required	Description
`input`	`unknown`	Yes	Unknown configuration with at most 100 unique site profiles and an optional absolute Bun executable path.

Returns

SiteOperationsConfig

A structured clone of the validated site catalog.

Remarks

Validation does not inspect registered filesystem paths, start a site or authenticate a remote endpoint.

Errors and rejections

If profiles, ports, script names, environment bindings or API endpoints violate the catalog contract.

Example

import { parseSiteOperationsConfig } from '@alneas/eaos-cli/site'
const config = parseSiteOperationsConfig({ sites: [] })

[FUNCTION] `pascalCase`

Convert a nonempty hyphen-separated identifier into concatenated capitalized segments.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/utils.

Signature

declare function pascalCase(id: string): string;

Parameters

Name	Type	Required	Description
`id`	`string`	Yes	Validated identifier with nonempty hyphen-separated segments.

Returns

string

The concatenated PascalCase identifier.

Errors and rejections

Empty segments cause a TypeError; validate untrusted identifiers first.

Example

import { pascalCase } from '@alneas/eaos-cli/plugin-tools'
const typeName = pascalCase('notes-api')

[FUNCTION] `planPlatformOperation`

Inspect release/bootstrap inputs and produce an execution plan without importing host operation code.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/operations.

Signature

declare function planPlatformOperation(root: string, operation: 'release' | 'bootstrap', options?: PlatformOperationOptions): Promise<{
    mode: "plan-only";
    operation: "release" | "bootstrap";
    inputSha256: string;
    preset: string | undefined;
    roles: {
        role: "backend" | "frontend" | "worker";
        image: string;
        version: string;
    }[];
    stages: string[];
    selectedPlugins: {
        owner: string;
        id: string;
    }[];
    requires: string;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Existing application root whose real path and immutable inputs are checked.
`operation`	`'release' \| 'bootstrap'`	Yes	release plans deployment roles; bootstrap requires a supported preset.
`options`	`PlatformOperationOptions`	No	Optional config/operations paths and stack selection; no operation callback is executed.

Returns

Plan-only metadata, input hash, roles, stages and selected plugins.

Errors and rejections

Rejects missing/invalid inputs, unsupported bootstrap configuration or inconsistent role/image selections.

Example

import { planPlatformOperation } from '@alneas/eaos-cli/platform'
export function reviewRelease(root: string) { return planPlatformOperation(root, 'release') }

[INTERFACE] `PlatformDeployment`

Non-secret image, database and deployment-target selections for platform generation.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/render.

Signature

interface PlatformDeployment {
    images: {
        backend: string;
        frontend: string;
        worker?: string;
        agentRuntime?: string;
        nginx?: string;
        kratos?: string;
        postgres?: string;
    };
    database?: {
        volumeName: string;
        external: boolean;
    };
    target?: 'compose' | 'kamal' | 'both';
    kamal?: KamalDeployment;
    placements?: DeploymentPlacements;
}

Parameters

Name	Type	Required	Description
`images`	`{ backend: string; frontend: string; worker?: string; agentRuntime?: string; nginx?: string; kratos?: string; postgres?: string; }`	Yes	Explicit application image names plus optional infrastructure images; release execution rejects unreviewed mutable tags.
`database`	`{ volumeName: string; external: boolean; }`	No	Database volume/external-provider selection; omitted settings use generator defaults.
`target`	`'compose' \| 'kamal' \| 'both'`	No	Output transport selection; defaults to compose. Kamal settings require kamal or both.
`kamal`	`KamalDeployment`	No	Kamal SSH hosts, role configuration and runtime file bindings for that target.
`placements`	`DeploymentPlacements`	No	Explicit component-to-destination catalog; unresolved required placements fail generation.

Returns

Type declaration; no runtime value.

Public members

`images`

Explicit application image names plus optional infrastructure images; release execution rejects unreviewed mutable tags.

`images.backend`

Required backend container image; Kamal requires an explicit tag, and release execution rejects dev/local/latest tags.

`images.frontend`

Required frontend container image; Kamal requires an explicit tag, and release execution rejects dev/local/latest tags.

`images.worker`

Optional worker application image; must be configured together with kamal.worker.

`images.agentRuntime`

Optional remote agent image; must be configured together with kamal.agentRuntime and upgraded through a separate reviewed operation.

`images.nginx`

Reverse-proxy image; defaults to nginx:1.30-alpine when omitted.

`images.kratos`

Identity service/migration image; defaults to oryd/kratos:v26.2.0 when omitted.

`images.postgres`

Local Kratos database image; defaults to postgres:16-alpine when omitted.

`database`

Database volume/external-provider selection; omitted settings use generator defaults.

`database.volumeName`

Named Kratos database volume; omission of the whole database object defaults to appName + -kratos-data.

`database.external`

Host supplies an external identity database when true; defaults to false only when the whole object is omitted.

`target`

Output transport selection; defaults to compose. Kamal settings require kamal or both.

`kamal`

Kamal SSH hosts, role configuration and runtime file bindings for that target.

`placements`

Explicit component-to-destination catalog; unresolved required placements fail generation.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `PlatformImageDeployOptions`

Reviewed image version, transport and host credentials for a real image deployment.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/deploy.

Signature

interface PlatformImageDeployOptions {
    configFile: string;
    version: string;
    transport?: 'kamal' | 'openssh';
    cwd?: string;
    env?: NodeJS.ProcessEnv;
    registry?: {
        server: string;
        username: string;
        password: string;
    };
}

Parameters

Name	Type	Required	Description
`configFile`	`string`	Yes	Explicit reviewed Kamal configuration filename.
`version`	`string`	Yes	Immutable selected image version; latest and invalid version tokens are rejected.
`transport`	`'kamal' \| 'openssh'`	No	Kamal by default; openssh selects the constrained single-host transport.
`cwd`	`string`	No	Trusted command working directory; defaults to process.cwd().
`env`	`NodeJS.ProcessEnv`	No	Subprocess environment; defaults to process.env and may contain real secret bindings.
`registry`	`{ server: string; username: string; password: string; }`	No	Optional trusted registry server/username/password consumed only by the OpenSSH transport; Kamal uses its own configuration/environment. Never serialize these credentials in a receipt.

Returns

Type declaration; no runtime value.

Public members

`configFile`

Explicit reviewed Kamal configuration filename.

`version`

Immutable selected image version; latest and invalid version tokens are rejected.

`transport`

Kamal by default; openssh selects the constrained single-host transport.

`cwd`

Trusted command working directory; defaults to process.cwd().

`env`

Subprocess environment; defaults to process.env and may contain real secret bindings.

`registry`

Optional trusted registry server/username/password consumed only by the OpenSSH transport; Kamal uses its own configuration/environment. Never serialize these credentials in a receipt.

`registry.server`

Registry hostname that must exactly match the reviewed Kamal image registry before OpenSSH login.

`registry.username`

Nonempty host registry username passed to Docker login over the OpenSSH transport.

`registry.password`

Nonempty registry secret passed through SSH stdin to docker login –password-stdin; not used by the Kamal transport.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `PlatformManifest`

Host application configuration whose explicit selections determine generated platform files.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/render.

Signature

interface PlatformManifest {
    siteOperations?: SiteOperationsConfig;
    runtime?: PlatformRuntimeConfig;
    packages?: PlatformPackage[];
    platform: PlatformConfig;
    overrides?: PlatformConfigOverrides;
    deployment: PlatformDeployment;
}

Parameters

Name	Type	Required	Description
`siteOperations`	`SiteOperationsConfig`	No	Optional registered local site and control-service capabilities.
`runtime`	`PlatformRuntimeConfig`	No	Optional explicit tenant/database runtime placement catalog.
`packages`	`PlatformPackage[]`	No	Explicit acquired code registrations; each is bound to a verified inventory.
`platform`	`PlatformConfig`	Yes	Core platform service/domain/identity configuration.
`overrides`	`PlatformConfigOverrides`	No	Supported host overrides applied while resolving the platform contract.
`deployment`	`PlatformDeployment`	Yes	Non-secret image, transport, database and placement selection.

Returns

Type declaration; no runtime value.

Public members

`siteOperations`

Optional registered local site and control-service capabilities.

`runtime`

Optional explicit tenant/database runtime placement catalog.

`packages`

Explicit acquired code registrations; each is bound to a verified inventory.

`platform`

Core platform service/domain/identity configuration.

`overrides`

Supported host overrides applied while resolving the platform contract.

`deployment`

Non-secret image, transport, database and placement selection.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `PlatformOperationOptions`

Application configuration, operation module and plan/stack selections.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/operations.

Signature

interface PlatformOperationOptions {
    config?: string;
    operations?: string;
    plan?: boolean;
    stack?: string;
}

Parameters

Name	Type	Required	Description
`config`	`string`	No	Workspace-relative application manifest path; defaults to eaos.platform.json.
`operations`	`string`	No	Trusted operation module path; defaults to eaos.operations.ts.
`plan`	`boolean`	No	When true, inspect inputs/stages without importing live host operation code.
`stack`	`string`	No	Explicit Pulumi stack required for bootstrap execution.

Returns

Type declaration; no runtime value.

Public members

`config`

Workspace-relative application manifest path; defaults to eaos.platform.json.

`operations`

Trusted operation module path; defaults to eaos.operations.ts.

`plan`

When true, inspect inputs/stages without importing live host operation code.

`stack`

Explicit Pulumi stack required for bootstrap execution.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `PlatformOperations`

Trusted live host capabilities required to execute reviewed release/bootstrap operations.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/operations.

Signature

interface PlatformOperations {
    formatVersion: 1;
    environment: string;
    withLock<T>(context: ReleaseContext, action: () => Promise<T>): Promise<T>;
    lifecycle: LifecycleProject;
    migrations: Array<{
        backendId: string;
        tenantId: string;
        pluginIds: string[];
    }>;
    deploy?: (input: {
        context: ReleaseContext;
        role: 'worker' | 'backend' | 'frontend';
        image: string;
        version: string;
        configFile: string;
    }) => Promise<void>;
    baselines?: Array<{
        backendId: string;
        baseline: DataContractBaseline;
    }>;
    health: Array<{
        role: 'worker' | 'backend' | 'frontend';
        url: string;
    }>;
    bootstrap?: {
        provisionInfrastructure?: (context: ReleaseContext, stack: string) => Promise<void>;
        initializeControlDatabase(context: ReleaseContext): Promise<void>;
        startIdentity(context: ReleaseContext): Promise<void>;
        issueAdminRegistration(context: ReleaseContext): Promise<void>;
    };
}

Parameters

Name	Type	Required	Description
`formatVersion`	`1`	Yes	Host operations contract format; must be 1.
`environment`	`string`	Yes	Nonblank host environment identity used to bind locks, journals and health checks.
`withLock`	`Promise<T>`	Yes	Hold an environment-wide exclusive lock across the awaited action; lock ownership and recovery are host responsibilities.
`lifecycle`	`LifecycleProject`	Yes	Real Lifecycle project with shared durable state, migration executors and current admission.
`migrations`	`Array<{ backendId: string; tenantId: string; pluginIds: string[]; }>`	Yes	Explicit backend/tenant/plugin selections for reviewed release application; does not enable new tenants.
`deploy`	`(input: { context: ReleaseContext; role: 'worker' \| 'backend' \| 'frontend'; image: string; version: string; configFile: string; }) => Promise<void>`	No	Optional live role deployment callback receiving immutable image/version/config and the current release context.
`baselines`	`Array<{ backendId: string; baseline: DataContractBaseline; }>`	No	Optional reviewed database baseline descriptors bound to their exact backend IDs.
`health`	`Array<{ role: 'worker' \| 'backend' \| 'frontend'; url: string; }>`	Yes	Role-specific readiness URLs whose release headers must match the requested deployed versions.
`bootstrap`	`{ provisionInfrastructure?: (context: ReleaseContext, stack: string) => Promise<void>; initializeControlDatabase(context: ReleaseContext): Promise<void>; startIdentity(context: ReleaseContext): Promise<void>; issueAdminRegistration(context: ReleaseContext): Promise<void>; }`	No	Optional real infrastructure, control-DB, identity and administrator-code capabilities required for bootstrap.

Returns

Type declaration; no runtime value.

Public members

`formatVersion`

Host operations contract format; must be 1.

`environment`

Nonblank host environment identity used to bind locks, journals and health checks.

`withLock`

Hold an environment-wide exclusive lock across the awaited action; lock ownership and recovery are host responsibilities.

Parameters:

context: Reviewed release identity and input hash; the object is not frozen and must not be mutated.
action: Async host operation to await without releasing the exclusive environment lock.

Returns: The action result after the host lock implementation completes.

Type parameters

T: Result produced by the action while the environment lock is held.

Remarks

The host must release only its own lock and must not silently expire an interrupted writer.

Errors and rejections

Host lock acquisition, action and cleanup failures propagate.

Example:

import type { PlatformOperations, ReleaseContext } from '@alneas/eaos-cli/platform';
export async function inspectLocked(operations: PlatformOperations, context: ReleaseContext) {
  return operations.withLock(context, async () => operations.lifecycle.store.read());
}

`lifecycle`

Real Lifecycle project with shared durable state, migration executors and current admission.

`migrations`

Explicit backend/tenant/plugin selections for reviewed release application; does not enable new tenants.

`migrations[].backendId`

Registered backend ID matching the runtime/lifecycle target.

`migrations[].tenantId`

Concrete verified tenant ID; wildcards are rejected.

`migrations[].pluginIds`

Nonempty unique plugin IDs whose dependencies are migrated in order.

`deploy`

Optional live role deployment callback receiving immutable image/version/config and the current release context.

`deploy.input.context`

Current locked release context and retained operation identity for this deployment.

`deploy.input.role`

Reviewed worker, backend or frontend service selected for this live release step.

`deploy.input.image`

Exact reviewed immutable application image reference for the selected role.

`deploy.input.version`

Reviewed image/deployment version passed to the host deploy adapter.

`deploy.input.configFile`

Generated role-specific deployment configuration path selected by the reviewed release plan.

`baselines`

Optional reviewed database baseline descriptors bound to their exact backend IDs.

`baselines[].backendId`

Declared migration backend whose database owns this baseline.

`baselines[].baseline`

Reviewed baseline whose target must match the lifecycle contract catalog.

`health`

Role-specific readiness URLs whose release headers must match the requested deployed versions.

`health[].role`

Deployed role; release requires exactly one endpoint for each selected role.

`health[].url`

HTTPS or loopback HTTP URL without credentials/query/fragment; response x-eaos-release must match the selected version.

`bootstrap`

Optional real infrastructure, control-DB, identity and administrator-code capabilities required for bootstrap.

`bootstrap.provisionInfrastructure`

Optional host provisioning callback receiving reviewed context and explicit Pulumi stack; resolves with no value. Omission runs the local Pulumi project through the selected runner.

`bootstrap.initializeControlDatabase`

Initializes the real host control database during bootstrap.

Parameters:

context: Reviewed operation identity and input hash.

Returns: No value; resolves after host initialization.

Errors and rejections

Host initialization errors stop bootstrap without undoing earlier stages.

Example:

import type { PlatformOperations, ReleaseContext } from '@alneas/eaos-cli/platform';
export async function reviewedBootstrap(operations: PlatformOperations, context: ReleaseContext) {
  if (!operations.bootstrap) throw new Error("Real bootstrap capabilities required");
  // Invoke only after the host approves this operation and preceding stages.
  await operations.bootstrap.initializeControlDatabase(context);
}

`bootstrap.startIdentity`

Starts/configures the host identity service after control database initialization.

Parameters:

context: Reviewed operation identity and input hash.

Returns: No value; resolves after host identity setup.

Errors and rejections

Host setup errors stop bootstrap without undoing earlier stages.

Example:

import type { PlatformOperations, ReleaseContext } from '@alneas/eaos-cli/platform';
export async function reviewedBootstrap(operations: PlatformOperations, context: ReleaseContext) {
  if (!operations.bootstrap) throw new Error("Real bootstrap capabilities required");
  // Invoke only after the host approves this operation and preceding stages.
  await operations.bootstrap.startIdentity(context);
}

`bootstrap.issueAdminRegistration`

Delivers the host’s short-lived single-use administrator registration code directly.

Parameters:

context: Reviewed operation identity and input hash.

Returns: No value; credentials must not be returned for inclusion in receipts.

Errors and rejections

Delivery/setup errors stop bootstrap; the host must reconcile any code already issued.

Example:

import type { PlatformOperations, ReleaseContext } from '@alneas/eaos-cli/platform';
export async function reviewedBootstrap(operations: PlatformOperations, context: ReleaseContext) {
  if (!operations.bootstrap) throw new Error("Real bootstrap capabilities required");
  // Invoke only after the host approves this operation and preceding stages.
  await operations.bootstrap.issueAdminRegistration(context);
}

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `PlatformPackage`

Compatibility re-export; its implementation and documentation are owned by the owning API reference.

Imports: @alneas/eaos-cli/platform.

Signature

interface PlatformPackage {
    id: string;
    inventory: string;
    module: string;
    tenantIds: string[];
    pluginIds: string[];
    settings?: Record<string, unknown>;
}

Parameters

Name	Type	Required	Description
`id`	`string`	Yes	See the upstream owning declaration.
`inventory`	`string`	Yes	See the upstream owning declaration.
`module`	`string`	Yes	See the upstream owning declaration.
`tenantIds`	`string[]`	Yes	See the upstream owning declaration.
`pluginIds`	`string[]`	Yes	See the upstream owning declaration.
`settings`	`Record<string, unknown>`	No	See the upstream owning declaration.

Returns

Type declaration; no runtime value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `platformPackageBundleId`

Derive a lifecycle-safe package bundle identifier from the exact package identity bytes.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/packages.

Signature

declare function platformPackageBundleId(packageId: string): string;

Parameters

Name	Type	Required	Description
`packageId`	`string`	Yes	Nonblank package identity, including an optional npm scope; nonblank input is not trimmed before hashing.

Returns

string

package- followed by the SHA-256 hexadecimal digest.

Errors and rejections

If the package identity is blank.

Example

import { platformPackageBundleId } from '@alneas/eaos-cli/platform'
const bundleId = platformPackageBundleId('@example/notes')

[INTERFACE] `PlatformRuntimeConfig`

Compatibility re-export; its implementation and documentation are owned by the owning API reference.

Imports: @alneas/eaos-cli/platform.

Signature

interface PlatformRuntimeConfig {
    backend: BackendTarget;
    databaseTargets?: BackendTarget[];
    tenantPlacements?: Record<string, string>;
}

Parameters

Name	Type	Required	Description
`backend`	`BackendTarget`	Yes	See the upstream owning declaration.
`databaseTargets`	`BackendTarget[]`	No	See the upstream owning declaration.
`tenantPlacements`	`Record<string, string>`	No	See the upstream owning declaration.

Returns

Type declaration; no runtime value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `PluginDevConfig`

Trusted development-only plugin and optional test-host capabilities.

Imports: @alneas/eaos-cli/dev.

Signature

interface PluginDevConfig {
    plugin: DefinedPlugin;
    contracts?: DataContract[];
    seed?: (db: SQLiteDataAccessAdapter, principal: PlatformPrincipal) => Promise<void>;
    services?: Record<string, unknown>;
    monthlyQuotas?: Readonly<Record<string, number>>;
    clients?: {
        web?: DevClientEntry;
        line?: DevClientEntry;
    };
    mcp?: {
        registry: PluginRegistry;
        gatekeeper: McpGatekeeper;
    };
    resolveSecret?: (principal: PlatformPrincipal, key: string) => Promise<string>;
    jobs?: Record<string, (context: PluginContext, input: unknown) => Promise<void>>;
    webhooks?: Record<string, (principal: PlatformPrincipal, request: Request) => Promise<boolean>>;
}

Parameters

Name	Type	Required	Description
`plugin`	`DefinedPlugin`	Yes	Trusted Core plugin definition mounted by the disposable local runtime.
`contracts`	`DataContract[]`	No	Explicit Data Contracts required by schemaDependencies; missing migrations reject startup.
`seed`	`(db: SQLiteDataAccessAdapter, principal: PlatformPrincipal) => Promise<void>`	No	Optional async per-tenant seed callback receiving the scoped database and verified local persona; called on that tenant’s first access.
`services`	`Record<string, unknown>`	No	Explicit host capabilities exposed to trusted plugin code.
`monthlyQuotas`	`Readonly<Record<string, number>>`	No	Local test budgets keyed by addon or plugin; omitted or zero budgets do not fabricate metered allowance.
`clients`	`{ web?: DevClientEntry; line?: DevClientEntry; }`	No	Trusted web/LINE component entry declarations; never import server configuration into the browser bundle.
`mcp`	`{ registry: PluginRegistry; gatekeeper: McpGatekeeper; }`	No	Optional registry and gatekeeper for exactly the same plugin and entitlement.
`resolveSecret`	`(principal: PlatformPrincipal, key: string) => Promise<string>`	No	Async host callback resolving one secret key for the supplied verified local principal; missing binding rejects secret access.
`jobs`	`Record<string, (context: PluginContext, input: unknown) => Promise<void>>`	No	Explicit async job handlers keyed by operation; receive scoped plugin context and caller input.
`webhooks`	`Record<string, (principal: PlatformPrincipal, request: Request) => Promise<boolean>>`	No	Named async test validators receiving the local principal and Request; return whether admission is allowed.

Returns

Type declaration; no runtime value.

Public members

`plugin`

Trusted Core plugin definition mounted by the disposable local runtime.

`contracts`

Explicit Data Contracts required by schemaDependencies; missing migrations reject startup.

`seed`

Optional async per-tenant seed callback receiving the scoped database and verified local persona; called on that tenant’s first access.

`services`

Explicit host capabilities exposed to trusted plugin code.

`monthlyQuotas`

Local test budgets keyed by addon or plugin; omitted or zero budgets do not fabricate metered allowance.

`clients`

Trusted web/LINE component entry declarations; never import server configuration into the browser bundle.

`clients.web`

Trusted web component entry compiled into the local browser preview; omission leaves that preview unconfigured.

`clients.line`

Trusted LINE preview entry; when omitted, the web entry is reused if present.

`mcp`

Optional registry and gatekeeper for exactly the same plugin and entitlement.

`mcp.registry`

Registry containing exactly this development plugin with a matching entitlement declaration; startup rejects other compositions.

`mcp.gatekeeper`

Host-selected tool policy and audit service shared by local MCP discovery/execution.

`resolveSecret`

Async host callback resolving one secret key for the supplied verified local principal; missing binding rejects secret access.

`jobs`

Explicit async job handlers keyed by operation; receive scoped plugin context and caller input.

`webhooks`

Named async test validators receiving the local principal and Request; return whether admission is allowed.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `PluginInspection`

Source-inspected plugin metadata and explicit unresolved issues, without executing plugin code.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/inspect.

Signature

interface PluginInspection {
    apiPrefix?: string;
    targets?: string[];
    dataContracts?: Record<string, string>;
    pluginId: string;
    tables: string[];
    tools: {
        name: string;
        parametersHash: string;
        inputSchema?: Record<string, unknown>;
        contract?: {
            version: string;
            permission: string;
            sideEffect: 'read' | 'write' | 'external';
            outputSchema?: Record<string, unknown>;
        };
    }[];
    policies: Record<string, {
        requiredRole?: string;
        riskLevel?: string;
        requireHumanApproval?: boolean;
    }>;
    contracts: string[];
    secrets: string[];
    storagePolicy?: PluginStoragePolicy;
    issues: {
        code: string;
        message: string;
    }[];
}

Parameters

Name	Type	Required	Description
`apiPrefix`	`string`	No	Statically declared API route prefix when it can be resolved.
`targets`	`string[]`	No	Statically declared supported runtime/client targets.
`dataContracts`	`Record<string, string>`	No	Declared Data Contract identities and compatible version ranges.
`pluginId`	`string`	Yes	Validated plugin identity read from source declarations.
`tables`	`string[]`	Yes	Table names inferred from source contracts; not proof of installed physical schemas.
`tools`	`{ name: string; parametersHash: string; inputSchema?: Record<string, unknown>; contract?: { version: string; permission: string; sideEffect: 'read' \| 'write' \| 'external'; outputSchema?: Record<string, unknown>; }; }[]`	Yes	Statically inspected tool names, input hashes/schema and optional execution contracts.
`policies`	`Record<string, { requiredRole?: string; riskLevel?: string; requireHumanApproval?: boolean; }>`	Yes	Resolved per-tool role, risk and human-approval metadata; runtime hosts still enforce live authorization.
`contracts`	`string[]`	Yes	Source contract declarations found by the static reader.
`secrets`	`string[]`	Yes	Declared secret names, never resolved secret values.
`storagePolicy`	`PluginStoragePolicy`	No	Optional declared plugin storage limits and placement rules.
`issues`	`{ code: string; message: string; }[]`	Yes	Unresolved/unsupported source findings; callers must not silently treat them as a complete executable contract.

Returns

Type declaration; no runtime value.

Public members

`apiPrefix`

Statically declared API route prefix when it can be resolved.

`targets`

Statically declared supported runtime/client targets.

`dataContracts`

Declared Data Contract identities and compatible version ranges.

`pluginId`

Validated plugin identity read from source declarations.

`tables`

Table names inferred from source contracts; not proof of installed physical schemas.

`tools`

Statically inspected tool names, input hashes/schema and optional execution contracts.

`tools[].name`

Statically resolved MCP tool name from the inspected plugin source.

`tools[].parametersHash`

SHA-256 of JSON.stringify applied to the statically resolved input schema; source object key order therefore affects compatibility comparisons.

`tools[].inputSchema`

Optional source-resolved JSON Schema for tool arguments; unresolved expressions are reported as inspection issues.

`tools[].contract`

Optional statically resolved execution contract describing version, permission, effects, and output validation.

`tools[].contract.version`

Declared execution-contract version string used for compatibility comparisons.

`tools[].contract.permission`

Declared permission key required by the execution contract; inspection does not enforce it.

`tools[].contract.sideEffect`

Declared effect category: read, write, or external; runtime hosts must enforce the corresponding execution boundary.

`tools[].contract.outputSchema`

Optional statically resolved result JSON Schema; absence does not imply result validation.

`policies`

Resolved per-tool role, risk and human-approval metadata; runtime hosts still enforce live authorization.

`policies.requiredRole`

Optional source-declared role requirement; live runtime authorization remains host-owned.

`policies.riskLevel`

Optional source-declared tool risk label, without a runtime policy decision from inspection.

`policies.requireHumanApproval`

Optional source declaration indicating whether the tool requests human approval.

`contracts`

Source contract declarations found by the static reader.

`secrets`

Declared secret names, never resolved secret values.

`storagePolicy`

Optional declared plugin storage limits and placement rules.

`issues`

Unresolved/unsupported source findings; callers must not silently treat them as a complete executable contract.

`issues[].code`

Stable diagnostic category identifying unsupported, unresolved, or conflicting inspected source.

`issues[].message`

Human-readable diagnostic context; callers must review these findings before treating metadata as complete.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `preparePluginDeployment`

Finalize deployment assets and exact hashes in an isolated built plugin package before packing.

Imports: @alneas/eaos-cli/platform/deployment-assets.

Signature

declare function preparePluginDeployment(root: string): Promise<DeploymentInventory>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Staging directory containing canonical package.json, deployment.json and built dist/runtime.js.

Returns

Promise<DeploymentInventory>

The verified deployment inventory written into the staging directory.

Remarks

Writes deployment.json. Do not pass a released immutable artifact or live host directory; this does not deploy or enable a tenant.

Errors and rejections

Rejects owner/version mismatches, missing lifecycle/runtime/assets, symlinks and inventory or filesystem failures.

Example

import { preparePluginDeployment } from '@alneas/eaos-cli/platform/deployment-assets'
export function finalizeStaging(directory: string) { return preparePluginDeployment(directory) }

[INTERFACE] `PresetManifest`

Supported OCI preset selections layered over a host platform manifest.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/preset.

Signature

interface PresetManifest extends Omit<PlatformManifest, 'deployment'> {
    preset: 'oci-adb' | 'oci-adb-standard';
    plugins?: string[];
    corporatePackages?: Array<{
        id: string;
        path: string;
        tenants: string[];
    }>;
    deployment?: Omit<Partial<PlatformManifest['deployment']>, 'images'> & {
        images?: Partial<PlatformManifest['deployment']['images']>;
    };
}

Parameters

Name	Type	Required	Description
`preset`	`'oci-adb' \| 'oci-adb-standard'`	Yes	Explicit supported infrastructure preset; oci-adb-standard is the accepted alias of oci-adb.
`plugins`	`string[]`	No	Unique installed npm package identities selected for this host; code selection is not activation.
`corporatePackages`	`Array<{ id: string; path: string; tenants: string[]; }>`	No	Explicit local private package paths and tenant allowlists selected by the host.
`deployment`	`Omit<Partial<PlatformManifest['deployment']>, 'images'> & { images?: Partial<PlatformManifest['deployment']['images']>; }`	No	Optional deployment overrides layered over the preset’s local Compose defaults.

Returns

Type declaration; no runtime value.

Public members

`preset`

Explicit supported infrastructure preset; oci-adb-standard is the accepted alias of oci-adb.

`plugins`

Unique installed npm package identities selected for this host; code selection is not activation.

`corporatePackages`

Explicit local private package paths and tenant allowlists selected by the host.

`corporatePackages[].id`

Expected package owner identifier, required to match its deployment inventory.

`corporatePackages[].path`

Project-contained directory containing the acquired package deployment.json and verified assets.

`corporatePackages[].tenants`

Explicit nonempty tenant allowlist for the package registration, validated by platform package rules.

`deployment`

Optional deployment overrides layered over the preset’s local Compose defaults.

`deployment.images`

Optional per-role image overrides merged over local appName-backend:dev and appName-frontend:dev tags before platform defaults are resolved.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `readDeploymentPlacementConfig`

Load explicit destination placements from the application manifest without discovering plugin code.

Imports: @alneas/eaos-cli/platform/deployment-placement-config.

Signature

declare function readDeploymentPlacementConfig(root: string, config: string): Promise<{
    placements: _alneas_eaos_server_platform.DeploymentPlacements;
    bindings: Record<string, string>;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Existing application root, canonicalized through realpath.
`config`	`string`	Yes	Workspace-relative application manifest path.

Returns

Promise<{ placements: _alneas_eaos_server_platform.DeploymentPlacements; bindings: Record<string, string>; }>

The resolved placement catalog and host placement bindings.

Errors and rejections

Rejects missing placements, invalid manifest paths/configuration and read failures.

Example

import { readDeploymentPlacementConfig } from '@alneas/eaos-cli/platform/deployment-placement-config'
export function placements(root: string) { return readDeploymentPlacementConfig(root, 'eaos.platform.json') }

[FUNCTION] `readJson`

Read a JSON file of at most 1 MiB and retain its original UTF-8 text.

Imports: @alneas/eaos-cli/platform.

Signature

declare function readJson(path: string): Promise<{
    data: unknown;
    text: string;
}>;

Parameters

Name	Type	Required	Description
`path`	`string`	Yes	File selected by the trusted caller; use safePath for workspace containment.

Returns

Promise<{ data: unknown; text: string; }>

The parsed data and original text, without a content hash.

Remarks

lstat rejects a final symlink because it is not a regular file. Parent components are not checked here; use safePath for workspace-relative paths. Checks and reads are separate filesystem operations, so callers must control concurrent path changes.

Errors and rejections

Rejects missing, nonregular or oversized files, invalid JSON and read failures.

Public members

`result.data`

Parsed JSON value without runtime domain-schema validation.

`result.text`

Original UTF-8 JSON file text retained exactly for hashing or inspection.

Example

import { readJson } from '@alneas/eaos-cli/platform'
export function readManifest(path: string) { return readJson(path) }

[FUNCTION] `readPlatformPackages`

Read registered package metadata from the application manifest.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/packages.

Signature

declare function readPlatformPackages(root: string, config?: string): Promise<PlatformPackage[]>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted application root.
`config`	`string`	No	Workspace-relative manifest path; defaults to eaos.platform.json.

Returns

Promise<PlatformPackage[]>

The resolved application package registrations.

Remarks

Reads and resolves metadata without importing runtime factories or activating plugins.

Errors and rejections

Rejects invalid manifest paths, declarations or package metadata; filesystem errors propagate.

Example

import { readPlatformPackages } from '@alneas/eaos-cli/platform'
export function readHost(root: string) { return readPlatformPackages(root) }

[FUNCTION] `readPlatformRuntime`

Read runtime placement configuration from the application manifest.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/packages.

Signature

declare function readPlatformRuntime(root: string, config?: string): Promise<PlatformRuntimeConfig | undefined>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted application root.
`config`	`string`	No	Workspace-relative manifest path; defaults to eaos.platform.json.

Returns

Promise<PlatformRuntimeConfig \| undefined>

The resolved optional runtime configuration.

Remarks

Reads and resolves metadata without importing runtime factories or activating plugins.

Errors and rejections

Rejects invalid manifest paths, declarations or package metadata; filesystem errors propagate.

Example

import { readPlatformRuntime } from '@alneas/eaos-cli/platform'
export function readHost(root: string) { return readPlatformRuntime(root) }

[FUNCTION] `recordDeploymentResult`

Append reviewed deployment evidence under an exclusive journal writer lock without executing its task.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/deployment-status.

Signature

declare function recordDeploymentResult(root: string, options: {
    inventory: string;
    receipt: string;
    result: DeploymentResult;
    config?: string;
    destination?: string;
}): Promise<{
    receipt: string;
    recorded: DeploymentResult;
    executed: boolean;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted workspace root used to validate the receipt path.
`options`	`{ inventory: string; receipt: string; result: DeploymentResult; config?: string; destination?: string; }`	Yes	Inventory, relative receipt path and actual observed result; placement-bound work also supplies config/destination.

Returns

Promise<{ receipt: string; recorded: DeploymentResult; executed: boolean; }>

The receipt path, recorded result and executed=false.

Remarks

The host supplies truthful evidence. Writes a temporary journal then renames it; no task, migration or tenant activation runs.

Errors and rejections

Rejects changed artifacts, wrong release/target/placement evidence, immutable-asset receipt paths, existing writer locks, oversized journals and filesystem errors.

Public members

`options.inventory`

Path to the immutable deployment inventory whose owner, asset hashes and task declaration bind this result.

`options.receipt`

Workspace-relative mutable evidence journal path; must remain separate from the immutable inventory and packaged assets.

`options.result`

Truthful host/operator-observed task result with actor, timestamp, evidence and required scope; recording does not execute or independently verify its task.

`options.config`

Optional workspace-relative application manifest supplying reviewed placements; required for destination-bound evidence.

`options.destination`

Optional destination ID assigned to this nonartifact task; requires config with compatible explicit placements.

Example

import { recordDeploymentResult } from '@alneas/eaos-cli/platform'
export function appendEvidence(root: string, options: Parameters<typeof recordDeploymentResult>[1]) { return recordDeploymentResult(root, options) }

[FUNCTION] `referenceOciAutonomousDatabase`

Read an external Autonomous Database resource without importing it into managed state.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/database.

Signature

declare function referenceOciAutonomousDatabase(name: string, id: pulumi.Input<string>, options?: Omit<pulumi.CustomResourceOptions, 'import'>): _pulumi_oci_database_autonomousDatabase.AutonomousDatabase;

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Pulumi logical lookup name.
`id`	`pulumi.Input<string>`	Yes	Existing database resource ID supplied by the host; may be an Output.
`options`	`Omit<pulumi.CustomResourceOptions, 'import'>`	No	Optional resource options excluding import.

Returns

_pulumi_oci_database_autonomousDatabase.AutonomousDatabase

The referenced native AutonomousDatabase resource.

Remarks

Requires Pulumi/OCI provider configuration. This lookup is not resource adoption, database migration or wallet creation.

Errors and rejections

Provider lookup errors propagate.

Example

import { referenceOciAutonomousDatabase } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function referenceHost(id: Parameters<typeof referenceOciAutonomousDatabase>[1]) { return referenceOciAutonomousDatabase('existing-db', id) }

[FUNCTION] `registerArchitectureCommands`

Imports: @alneas/eaos-cli/commands/architecture.

Signature

declare function registerArchitectureCommands(program: Command): void;

Parameters

Name	Type	Required	Description
`program`	`Command`	Yes	Commander command instance to mutate; its owning host controls argument parsing.

Returns

void

No value; command definitions and handlers are attached to the supplied object.

Remarks

Registration itself does not execute commands. Later parsing can invoke filesystem, infrastructure or deployment operations according to the selected command; review them separately.

Errors and rejections

Commander configuration errors propagate.

Example

import { registerArchitectureCommands } from '@alneas/eaos-cli/commands/architecture'
import { Command } from 'commander'
const program = new Command('example')
registerArchitectureCommands(program)

[FUNCTION] `registerClientCommands`

Imports: @alneas/eaos-cli/commands/sync-routes.

Signature

declare function registerClientCommands(program: Command): void;

Parameters

Name	Type	Required	Description
`program`	`Command`	Yes	Commander command instance to mutate; its owning host controls argument parsing.

Returns

void

No value; command definitions and handlers are attached to the supplied object.

Remarks

Registration itself does not execute synchronization. Parsing sync:routes reads client manifests and may write the owned route registry/receipt; it does not execute infrastructure or deployment operations.

Errors and rejections

Commander configuration errors propagate.

Example

import { registerClientCommands } from '@alneas/eaos-cli/commands/sync-routes'
import { Command } from 'commander'
const program = new Command('example')
registerClientCommands(program)

[FUNCTION] `registerDeploymentCommands`

Imports: @alneas/eaos-cli/commands/deployment.

Signature

declare function registerDeploymentCommands(program: Command): void;

Parameters

Name	Type	Required	Description
`program`	`Command`	Yes	Commander command instance to mutate; its owning host controls argument parsing.

Returns

void

No value; command definitions and handlers are attached to the supplied object.

Remarks

Registration itself does not execute commands. Parsing these commands reads/verifies artifacts and may append an evidence journal or set process.exitCode for incomplete status; it does not execute deployment tasks or apply infrastructure.

Errors and rejections

Commander configuration errors propagate.

Example

import { registerDeploymentCommands } from '@alneas/eaos-cli/commands/deployment'
import { Command } from 'commander'
const program = new Command('example')
registerDeploymentCommands(program)

[FUNCTION] `registerLifecycleCommands`

Imports: @alneas/eaos-cli/commands/lifecycle.

Signature

declare function registerLifecycleCommands(plugin: Command): void;

Parameters

Name	Type	Required	Description
`plugin`	`Command`	Yes	Commander command instance to mutate; its owning host controls argument parsing.

Returns

void

No value; command definitions and handlers are attached to the supplied object.

Remarks

Registration itself does not execute commands. Later parsing can invoke filesystem, infrastructure or deployment operations according to the selected command; review them separately.

Errors and rejections

Commander configuration errors propagate.

Example

import { registerLifecycleCommands } from '@alneas/eaos-cli/commands/lifecycle'
import { Command } from 'commander'
const program = new Command('example')
registerLifecycleCommands(program)

[FUNCTION] `registerPlatformPackage`

Acquire verified artifact bytes and atomically register code without executing package factories.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/packages.

Signature

declare function registerPlatformPackage(root: string, options: {
    directory: string;
    tenantIds: string[];
    settings?: Record<string, unknown>;
    config?: string;
}): Promise<{
    entry: PlatformPackage;
    verifiedAssets: number;
    activated: boolean;
    restartRequired: boolean;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Application workspace root.
`options`	`{ directory: string; tenantIds: string[]; settings?: Record<string, unknown>; config?: string; }`	Yes	Already built/downloaded directory, explicit tenantIds, optional settings and manifest path.

Returns

Promise<{ entry: PlatformPackage; verifiedAssets: number; activated: boolean; restartRequired: boolean; }>

The registration, verified asset count, activated=false and restartRequired=true.

Remarks

Writes immutable retained files and the application manifest under a registration lock. Partial acquisition may remain after failure; no database application or tenant activation occurs.

Errors and rejections

Rejects invalid hashes, duplicate package identities, mismatched retained assets, registration locks or filesystem failures.

Public members

`options.directory`

Already built/downloaded artifact directory containing deployment.json and its checksummed assets; resolved against the process working directory.

`options.tenantIds`

Explicit nonempty verified concrete tenant catalog to register for this package; registration never activates these tenants.

`options.settings`

Optional nonsecret settings object retained in the package registration; actual durable/authentication bindings stay host-owned.

`options.config`

Workspace-relative application manifest to update under the registration lock; defaults to eaos.platform.json.

Example

import { registerPlatformPackage } from '@alneas/eaos-cli/platform'
export function acquireReviewed(root: string, directory: string, tenantIds: string[]) { return registerPlatformPackage(root, { directory, tenantIds }) }

[FUNCTION] `registerPluginCommands`

Imports: @alneas/eaos-cli/commands/plugin.

Signature

declare function registerPluginCommands(program: Command): void;

Parameters

Name	Type	Required	Description
`program`	`Command`	Yes	Commander command instance to mutate; its owning host controls argument parsing.

Returns

void

No value; command definitions and handlers are attached to the supplied object.

Remarks

Registration itself does not execute commands. Later parsing can invoke filesystem, infrastructure or deployment operations according to the selected command; review them separately.

Errors and rejections

Commander configuration errors propagate.

Example

import { registerPluginCommands } from '@alneas/eaos-cli/commands/plugin'
import { Command } from 'commander'
const program = new Command('example')
registerPluginCommands(program)

[CONSTANT] `registrationBodyFile`

Generated relative filename for the registration-email body template.

Imports: @alneas/eaos-cli/platform/render.

Signature

declare const registrationBodyFile = "kratos/registration-body.jsonnet";

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[CONSTANT] `registrationEmailBody`

Default registration-email body template rendered into host identity configuration.

Imports: @alneas/eaos-cli/platform/render.

Signature

declare const registrationEmailBody = "function(ctx) { email: ctx.identity.traits.email, identity_id: ctx.identity.id }\n";

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `ReleaseContext`

Execution identity and reviewed input hash passed to trusted release callbacks; hosts must preserve these values.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/operations.

Signature

interface ReleaseContext {
    root: string;
    id: string;
    inputSha256: string;
}

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Canonical application root associated with the reviewed inputs.
`id`	`string`	Yes	Unique operation UUID shared by its steps and durable receipt.
`inputSha256`	`string`	Yes	SHA-256 binding the operation to its reviewed source, package and configuration inputs.

Returns

Type declaration; no runtime value.

Public members

`root`

Canonical application root associated with the reviewed inputs.

`id`

Unique operation UUID shared by its steps and durable receipt.

`inputSha256`

SHA-256 binding the operation to its reviewed source, package and configuration inputs.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `renderAgentMetadata`

Serialize inspected contract metadata into a delimited generated AGENTS block.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/sync-agents-md.

Signature

declare function renderAgentMetadata(info: PluginInspection): string;

Parameters

Name	Type	Required	Description
`info`	`PluginInspection`	Yes	Reviewed source-inspection result; issues are omitted from serialized contract metadata.

Returns

string

Markdown with exact generated block markers and a JSON contract payload.

Remarks

Serialization alone does not reject unresolved issues or validate runtime authorization.

Errors and rejections

JSON serialization failures propagate.

Example

import { renderAgentMetadata } from '@alneas/eaos-cli/plugin-tools'
import { inspectPlugin } from '@alneas/eaos-cli/plugin-tools/inspect'
export function metadata(root: string) { return renderAgentMetadata(inspectPlugin(root, 'notes')) }

[FUNCTION] `renderDeploymentStatusMarkdown`

Render deployment completeness and optional remaining-task details as a Markdown report.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/deployment-status.

Signature

declare function renderDeploymentStatusMarkdown(status: Awaited<ReturnType<typeof inspectDeploymentStatus>>, options?: {
    remaining?: boolean;
    view?: 'plugin' | 'destination';
}): string;

Parameters

Name	Type	Required	Description
`status`	`Awaited<ReturnType<typeof inspectDeploymentStatus>>`	Yes	Verified status from inspectDeploymentStatus.
`options`	`{ remaining?: boolean; view?: 'plugin' \| 'destination'; }`	No	remaining omits already succeeded work from detailed task sections.

Returns

string

Markdown status text with table cells escaped.

Remarks

Rendering is presentation only; it neither revalidates evidence nor performs an operation.

Errors and rejections

Malformed caller-supplied status objects can fail during rendering.

Public members

`options.remaining`

When true, omit succeeded work from detailed sections; false/omitted includes all task states.

`options.view`

Plugin view by default; destination requires placement-aware status with destinations and shared artifact executions.

Example

import { renderDeploymentStatusMarkdown } from '@alneas/eaos-cli/platform'
import { inspectDeploymentStatus } from '@alneas/eaos-cli/platform/deployment-status'
export async function report(inventory: string) { return renderDeploymentStatusMarkdown(await inspectDeploymentStatus([inventory]), { remaining: true }) }

[FUNCTION] `renderKamal`

Render role-specific Kamal configuration and operation metadata from validated deployment settings.

Imports: @alneas/eaos-cli/platform/kamal.

Signature

declare function renderKamal(config: ResolvedPlatformConfig, settings: ResolvedKamalDeployment, definitions: ServiceDefinition[], database: {
    volumeName: string;
    external: boolean;
}, workerImageValue?: string, agentImageValue?: string): Record<string, string>;

Parameters

Name	Type	Required	Description
`config`	`ResolvedPlatformConfig`	Yes	Resolved platform ports, domain and runtime configuration.
`settings`	`ResolvedKamalDeployment`	Yes	Validated Kamal host/service/registry settings.
`definitions`	`ServiceDefinition[]`	Yes	Explicit service definitions used for backend accessories.
`database`	`{ volumeName: string; external: boolean; }`	Yes	Selected database image, storage and connection configuration.
`workerImageValue`	`string`	No	Optional immutable worker image selection.
`agentImageValue`	`string`	No	Optional agent-runtime image selection.

Returns

Record<string, string>

A map of generated relative filenames to configuration text.

Remarks

Pure rendering: does not invoke Kamal, SSH, registry pushes or migrations. The host reviews generated settings and supplies actual runtime secrets.

Errors and rejections

Invalid settings or unresolved role/image assumptions can throw.

Public members

`database.volumeName`

Reviewed named Docker volume used for identity database persistence and generated host inspection/create instructions.

`database.external`

True requires the existing named volume to be inspected and retained; false permits reviewed new-installation volume creation instructions.

Example

import { renderKamal } from '@alneas/eaos-cli/platform/kamal'
export function renderHost(...args: Parameters<typeof renderKamal>) { return renderKamal(...args) }

[FUNCTION] `renderKamalSecretsScript`

Render the current Kamal dotenv resolver template without executing its shell substitutions.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/kamal-secrets.

Signature

declare function renderKamalSecretsScript(options?: KamalSecretsTemplateOptions): string;

Parameters

Name	Type	Required	Description
`options`	`KamalSecretsTemplateOptions`	No	Registry identity and Pulumi directory settings; see KamalSecretsTemplateOptions for defaults.

Returns

string

The generated template text.

Remarks

Current implementation embeds a fixed database-password literal and leaves the database connection string empty. Replace these through reviewed host secret bindings before production use. Registry substitution reads environment/Pulumi values only when the generated script is consumed; this renderer does not persist or fetch credentials.

Example

import { renderKamalSecretsScript } from '@alneas/eaos-cli/platform'
const text = renderKamalSecretsScript({ pulumiDir: 'pulumi' })

[FUNCTION] `renderOciAdbTemplate`

Render the initial host-owned Pulumi source files for the OCI ADB preset.

Imports: @alneas/eaos-cli/presets/oci-adb, @alneas/eaos-cli/presets/oci-adb/template.

Signature

declare function renderOciAdbTemplate(appName: string): Record<string, string>;

Parameters

Name	Type	Required	Description
`appName`	`string`	Yes	Lowercase resource prefix beginning with a letter and containing at most 49 letters/digits/hyphens.

Returns

Record<string, string>

Relative Pulumi filenames and complete generated UTF-8 text.

Remarks

Does not write files, access Pulumi configuration or create resources. The generated project depends on the selected published CLI/Pulumi versions and requires real host configuration.

Errors and rejections

If the application name does not match the resource-prefix grammar.

Example

import { renderOciAdbTemplate } from '@alneas/eaos-cli/presets/oci-adb'
const files = renderOciAdbTemplate('example-platform')

[FUNCTION] `renderPlatform`

Render platform application and infrastructure configuration as filename/text pairs.

Imports: @alneas/eaos-cli/platform/render.

Signature

declare function renderPlatform(config: ResolvedPlatformConfig, deployment: ResolvedDeployment, schemas: Record<string, unknown>, sources?: {
    registrationBody?: string;
    googleMapper?: string;
}): Record<string, string>;

Parameters

Name	Type	Required	Description
`config`	`ResolvedPlatformConfig`	Yes	Validated platform configuration.
`deployment`	`ResolvedDeployment`	Yes	Resolved images, database, target and placement configuration.
`schemas`	`Record<string, unknown>`	Yes	Identity schema records used by generated authentication configuration.
`sources`	`{ registrationBody?: string; googleMapper?: string; }`	No	Optional reviewed source/configuration text passed through to the renderer.

Returns

Record<string, string>

Generated configuration files and their textual content.

Remarks

Rendering does not write files, deploy services, rotate credentials or grant access.

Errors and rejections

Invalid or unsupported configuration can fail while rendering.

Public members

`sources.registrationBody`

Optional reviewed registration-hook Jsonnet text loaded by the caller; required when a custom body file is selected instead of the built-in identity-email-v1 body.

`sources.googleMapper`

Optional reviewed Google identity-mapper Jsonnet text loaded by the caller; required for a custom mapper instead of the built-in verified-email mapper.

Example

import { renderPlatform } from '@alneas/eaos-cli/platform/render'
export function renderHost(...args: Parameters<typeof renderPlatform>) { return renderPlatform(...args) }

[INTERFACE] `ResolvedDeployment`

Normalized deployment defaults and optional reviewed destination bindings.

Imports: @alneas/eaos-cli/platform/render.

Signature

interface ResolvedDeployment {
    images: Required<Omit<PlatformDeployment['images'], 'worker' | 'agentRuntime'>> & {
        worker?: string;
        agentRuntime?: string;
    };
    database: NonNullable<PlatformDeployment['database']>;
    target: NonNullable<PlatformDeployment['target']>;
    kamal?: ResolvedKamalDeployment;
    placements?: DeploymentPlacements;
    placementBindings?: Record<string, string>;
}

Parameters

Name	Type	Required	Description
`images`	`Required<Omit<PlatformDeployment['images'], 'worker' \| 'agentRuntime'>> & { worker?: string; agentRuntime?: string; }`	Yes	Infrastructure images with resolved defaults and any explicitly selected worker/agent images.
`database`	`NonNullable<PlatformDeployment['database']>`	Yes	Resolved database volume identity and external-provider flag.
`target`	`NonNullable<PlatformDeployment['target']>`	Yes	Resolved compose, kamal or both output selection.
`kamal`	`ResolvedKamalDeployment`	No	Validated normalized Kamal settings when selected.
`placements`	`DeploymentPlacements`	No	Validated destination and component placement selections.
`placementBindings`	`Record<string, string>`	No	Host-resolved placement fingerprints/bindings used to prevent evidence reuse across changed destinations.

Returns

Type declaration; no runtime value.

Public members

`images`

Infrastructure images with resolved defaults and any explicitly selected worker/agent images.

`images.worker`

Selected worker image when a worker host is configured; remains absent otherwise.

`images.agentRuntime`

Selected agent-runtime image when its host is configured; remains absent otherwise.

`database`

Resolved database volume identity and external-provider flag.

`target`

Resolved compose, kamal or both output selection.

`kamal`

Validated normalized Kamal settings when selected.

`placements`

Validated destination and component placement selections.

`placementBindings`

Host-resolved placement fingerprints/bindings used to prevent evidence reuse across changed destinations.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `resolveDeploymentPlugin`

Resolve declared asset selectors against the packaged path list.

Imports: @alneas/eaos-cli/platform/deployment-assets.

Signature

declare function resolveDeploymentPlugin(plugin: DeploymentPlugin, paths: string[], mapPattern?: (pattern: string) => string): DeploymentPlugin;

Parameters

Name	Type	Required	Description
`plugin`	`DeploymentPlugin`	Yes	Deployment plugin declaration whose selectors are resolved.
`paths`	`string[]`	Yes	Trusted relative package file paths.
`mapPattern`	`(pattern: string) => string`	No	Optional selector mapper; defaults to preserving each pattern.

Returns

DeploymentPlugin

Copied plugin metadata with sorted concrete assets and single-file runtime entries where appropriate.

Remarks

Does not read files or verify hashes; use verified staging paths and inventory checks separately.

Errors and rejections

If a declared asset selector matches no packaged path; mapper errors propagate.

Example

import { resolveDeploymentPlugin } from '@alneas/eaos-cli/platform/deployment-assets'
export function resolveAssets(plugin: Parameters<typeof resolveDeploymentPlugin>[0], paths: string[]) { return resolveDeploymentPlugin(plugin, paths) }

[INTERFACE] `ResolvedKamalDeployment`

Validated Kamal host and role configuration with default names and paths resolved.

Imports: @alneas/eaos-cli/platform/kamal.

Signature

interface ResolvedKamalDeployment {
    host: string;
    arch: 'amd64' | 'arm64';
    ssh: {
        user: string;
        port: number;
    };
    services: {
        backend: string;
        frontend: string;
    };
    registry: {
        usernameSecret: string;
        passwordSecret: string;
    };
    runtimeDirectory: string;
    runtimeFiles: {
        kratosConfig: string;
        databasePassword: string;
        tlsDirectory: string;
    };
    worker?: ResolvedKamalWorker;
    agentRuntime?: {
        host: string;
        privateAddress?: string;
        arch: 'amd64' | 'arm64';
        port: number;
        ssh: {
            user: string;
            port: number;
        };
        service: string;
        runtimeDirectory: string;
        tlsDirectory: string;
    };
}

Parameters

Name	Type	Required	Description
`host`	`string`	Yes	Reviewed SSH host or configured alias selected by the host.
`arch`	`'amd64' \| 'arm64'`	Yes	Container/host architecture, amd64 or arm64.
`ssh`	`{ user: string; port: number; }`	Yes	Optional trusted SSH user and port configuration.
`services`	`{ backend: string; frontend: string; }`	Yes	Explicit backend/frontend service names.
`registry`	`{ usernameSecret: string; passwordSecret: string; }`	Yes	Registry credential environment-binding names; plaintext values are supplied by the host at execution.
`runtimeDirectory`	`string`	Yes	Host runtime directory for generated configuration and secrets mounts.
`runtimeFiles`	`{ kratosConfig: string; databasePassword: string; tlsDirectory: string; }`	Yes	Registered host paths for identity configuration, database password and optional TLS files.
`worker`	`ResolvedKamalWorker`	No	Optional separate worker host and private service endpoints.
`agentRuntime`	`{ host: string; privateAddress?: string; arch: 'amd64' \| 'arm64'; port: number; ssh: { user: string; port: number; }; service: string; runtimeDirectory: string; tlsDirectory: string; }`	No	Optional separate agent-runtime host, port and reviewed network bindings.

Returns

Type declaration; no runtime value.

Public members

`host`

Reviewed SSH host or configured alias selected by the host.

`arch`

Container/host architecture, amd64 or arm64.

`ssh`

Optional trusted SSH user and port configuration.

`ssh.user`

Validated main-host SSH username.

`ssh.port`

Validated main-host SSH port, integer 1–65535.

`services`

Explicit backend/frontend service names.

`services.backend`

Validated backend Kamal service name, distinct from frontend.

`services.frontend`

Validated frontend Kamal service name, distinct from backend.

`registry`

Registry credential environment-binding names; plaintext values are supplied by the host at execution.

`registry.usernameSecret`

Validated environment-binding name for registry username lookup.

`registry.passwordSecret`

Validated environment-binding name for registry password lookup.

`runtimeDirectory`

Host runtime directory for generated configuration and secrets mounts.

`runtimeFiles`

Registered host paths for identity configuration, database password and optional TLS files.

`runtimeFiles.kratosConfig`

Validated absolute host identity-configuration path.

`runtimeFiles.databasePassword`

Validated absolute host database-password file path.

`runtimeFiles.tlsDirectory`

Validated absolute host platform TLS directory.

`worker`

Optional separate worker host and private service endpoints.

`agentRuntime`

Optional separate agent-runtime host, port and reviewed network bindings.

`agentRuntime.host`

Reviewed agent-runtime SSH host/alias; validation does not prove private network isolation.

`agentRuntime.privateAddress`

Optional host-selected address advertised for private runtime connections; omitted remains absent.

`agentRuntime.arch`

Validated selected runtime architecture.

`agentRuntime.port`

Validated agent service port, integer 1–65535.

`agentRuntime.ssh`

Normalized role SSH connection settings after input validation.

`agentRuntime.ssh.user`

Validated role SSH username.

`agentRuntime.ssh.port`

Validated role SSH port, integer 1–65535.

`agentRuntime.service`

Validated role service name used in generated Kamal configuration.

`agentRuntime.runtimeDirectory`

Validated absolute host agent-runtime directory.

`agentRuntime.tlsDirectory`

Validated absolute host directory containing agent-runtime TLS files.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `ResolvedKamalWorker`

Normalized worker role settings and its trusted private control endpoints.

Imports: @alneas/eaos-cli/platform/kamal.

Signature

interface ResolvedKamalWorker {
    host: string;
    privateAddress: string;
    kratosAdminUrl: string;
    arch: 'amd64' | 'arm64';
    ssh: {
        user: string;
        port: number;
    };
    service: string;
}

Parameters

Name	Type	Required	Description
`host`	`string`	Yes	Reviewed SSH host or alias used for worker deployment.
`privateAddress`	`string`	Yes	Host-selected private worker address used by other application components.
`kratosAdminUrl`	`string`	Yes	Trusted private Kratos administration endpoint; never a browser-selected URL.
`arch`	`'amd64' \| 'arm64'`	Yes	Validated worker architecture.
`ssh`	`{ user: string; port: number; }`	Yes	Resolved worker SSH user and port.
`service`	`string`	Yes	Resolved unique worker service name.

Returns

Type declaration; no runtime value.

Public members

`host`

Reviewed SSH host or alias used for worker deployment.

`privateAddress`

Host-selected private worker address used by other application components.

`kratosAdminUrl`

Trusted private Kratos administration endpoint; never a browser-selected URL.

`arch`

Validated worker architecture.

`ssh`

Resolved worker SSH user and port.

`ssh.user`

Validated worker SSH username derived from explicit worker/main SSH inputs; role validation requires one of those inputs.

`ssh.port`

Validated worker SSH port, integer 1–65535, inherited from the main SSH port when omitted.

`service`

Resolved unique worker service name.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `resolveKamal`

Validate a Kamal deployment against resolved platform ports, hosts and service settings.

Imports: @alneas/eaos-cli/platform/kamal.

Signature

declare function resolveKamal(value: unknown, config: ResolvedPlatformConfig): ResolvedKamalDeployment;

Parameters

Name	Type	Required	Description
`value`	`unknown`	Yes	Untrusted Kamal settings object.
`config`	`ResolvedPlatformConfig`	Yes	Resolved platform contract; networkName must be kamal.

Returns

ResolvedKamalDeployment

Normalized Kamal deployment settings with explicit host, registry, services and paths.

Remarks

Configuration validation does not contact SSH hosts or prove their authorization/security.

Errors and rejections

If settings contain unknown keys, invalid hosts/ports/paths or incompatible platform networking.

Example

import { resolveKamal } from '@alneas/eaos-cli/platform/kamal'
export function validateHost(value: unknown, config: Parameters<typeof resolveKamal>[1]) { return resolveKamal(value, config) }

[FUNCTION] `resolveManifest`

Validate a manifest or preset and resolve pure platform, deployment and package configuration.

Imports: @alneas/eaos-cli/platform/render.

Signature

declare function resolveManifest(input: unknown): {
    config: ResolvedPlatformConfig;
    deployment: ResolvedDeployment;
    packages: PlatformPackage[];
    runtime?: PlatformRuntimeConfig;
};

Parameters

Name	Type	Required	Description
`input`	`unknown`	Yes	Untrusted manifest value with explicit platform/deployment/package selections.

Returns

{ config: ResolvedPlatformConfig; deployment: ResolvedDeployment; packages: PlatformPackage[]; runtime?: PlatformRuntimeConfig; }

Resolved platform config, deployment, packages and optional runtime metadata.

Remarks

Does not load runtime factories or create resources; live adoption still requires reviewed host operations.

Errors and rejections

Rejects unknown fields, invalid presets, missing or incompatible runtime/database/image/placement settings.

Public members

`result.config`

Resolved platform identity, service, origin and runtime configuration after preset/override validation.

`result.deployment`

Resolved images, database volume, Compose/Kamal target and optional explicit placement/binding metadata.

`result.packages`

Validated explicit package registrations with concrete tenant/plugin scopes; factories are not loaded here.

`result.runtime`

Optional validated default/additional database targets and explicit tenant placements; absence means no platform runtime declaration.

Example

import { resolveManifest } from '@alneas/eaos-cli/platform/render'
export function parseHost(input: unknown) { return resolveManifest(input) }

[FUNCTION] `resolveProjectManifest`

Resolve an application manifest and installed package contributions into a deployment configuration.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/preset.

Signature

declare function resolveProjectManifest(root: string, input: unknown): Promise<{
    manifest: any;
    resolved: {
        config: _alneas_eaos_core_platform_config.ResolvedPlatformConfig;
        deployment: ResolvedDeployment;
        packages: PlatformPackage[];
        runtime?: _alneas_eaos_server_platform.PlatformRuntimeConfig;
    };
    inventories: string[];
    npmArtifacts: Omit<PlatformPackage, "tenantIds">[];
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted application root used to resolve package inventories.
`input`	`unknown`	Yes	Application manifest or supported preset declaration.

Returns

Promise<{ manifest: any; resolved: { config: _alneas_eaos_core_platform_config.ResolvedPlatformConfig; deployment: ResolvedDeployment; packages: PlatformPackage[]; runtime?: _alneas_eaos_server_platform.PlatformRuntimeConfig; }; inventories: string[]; npmArtifacts: Omit<PlatformPackage, "tenantIds">[]; }>

Resolved manifest/configuration and verified package contribution metadata.

Remarks

Package selection does not grant a tenant access or execute runtime factories.

Errors and rejections

Rejects invalid declarations, unavailable package inventories or incompatible placements.

Example

import { resolveProjectManifest } from '@alneas/eaos-cli/platform'
export function resolveHost(root: string, input: unknown) { return resolveProjectManifest(root, input) }

[FUNCTION] `runLocalSite`

Run a registered site build or bounded loopback preview with logs and an immutable run receipt.

Imports: @alneas/eaos-cli/site.

Signature

declare function runLocalSite(config: SiteOperationsConfig, id: string, kind: 'build' | 'preview', receiptRoot: string, options?: LocalSiteOptions): Promise<SiteRunReceipt>;

Parameters

Name	Type	Required	Description
`config`	`SiteOperationsConfig`	Yes	Validated catalog with explicit local Bun/directory bindings.
`id`	`string`	Yes	Registered site identifier.
`kind`	`'build' \| 'preview'`	Yes	build runs its build script; preview starts an expiring local proxy.
`receiptRoot`	`string`	Yes	Directory beneath which .eaos/site-runs stores logs and receipts.
`options`	`LocalSiteOptions`	No	Optional snapshot, AbortSignal, readiness callback and durationSeconds (1–7200); default duration is 600 for build and 1800 for preview.

Returns

Promise<SiteRunReceipt>

The succeeded build or stopped preview receipt, including hashes and log path.

Remarks

Executes trusted project scripts, not sandboxed code. Aborting/expiry terminates its process group and cleans temporary snapshots; arbitrary script effects are not undone. Captured logs replace exact forwarded environment values only when the variable name contains TOKEN, SECRET, PASSWORD, or KEY; this is not comprehensive credential redaction.

Errors and rejections

Rejects invalid bindings/snapshots/duration, unavailable ports, failed scripts, output limits or receipt writes; failure logs remain inspectable.

Example

import { runLocalSite } from '@alneas/eaos-cli/site'
export function previewRegistered(config: Parameters<typeof runLocalSite>[0], id: string, receiptRoot: string, signal: AbortSignal) { return runLocalSite(config, id, 'preview', receiptRoot, { signal, durationSeconds: 60 }) }

[CONSTANT] `runOperation`

Run one executable with argv and discarded stdin/stdout/stderr, rejecting unsuccessful exit.

Imports: @alneas/eaos-cli/platform/operations.

Signature

declare const runOperation: OperationRunner;

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

Resolves without a value when the executable exits zero.

Remarks

May execute real host side effects. Output is not captured in the returned error; no command allowlist, timeout or OS sandbox is provided by this runner.

Errors and rejections

Rejects startup errors, termination or a nonzero exit status.

Example

import { runOperation } from '@alneas/eaos-cli/platform/operations'
export function checkDocker(cwd: string) { return runOperation('docker', ['version'], { cwd }) }

[FUNCTION] `safePath`

Resolve a workspace-relative path while rejecting traversal and symlink escape.

Imports: @alneas/eaos-cli/platform.

Signature

declare function safePath(root: string, relative: string): Promise<string>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted workspace directory.
`relative`	`string`	Yes	Relative path within that workspace; absolute paths are rejected.

Returns

Promise<string>

The path formed under root after validating every component; this helper does not canonicalize root itself.

Errors and rejections

Rejects invalid paths, symlink escape and filesystem errors; missing final components are allowed for creation.

Example

import { safePath } from '@alneas/eaos-cli/platform'
export function manifestPath(root: string) { return safePath(root, 'eaos.platform.json') }

[FUNCTION] `selectAdbConnectionProfile`

Select exactly one nonempty provider TCPS connection profile without modifying its DSN.

Imports: @alneas/eaos-cli/presets/oci-adb/infra/database.

Signature

declare function selectAdbConnectionProfile(groups: readonly {
    profiles?: readonly AdbConnectionProfile[];
}[], selection?: OciAdbConnectionSelection): string;

Parameters

Name	Type	Required	Description
`groups`	`readonly { profiles?: readonly AdbConnectionProfile[]; }[]`	Yes	Provider connection-string groups and profiles.
`selection`	`OciAdbConnectionSelection`	No	Filters; defaults to LOW, SERVER, FQDN and LONG, with TCPS required; optional session/region/display-name filters narrow selection.

Returns

string

The exact matching provider DSN string.

Remarks

Diagnostics omit DSN contents. Selection does not validate live reachability, issue credentials or rewrite TLS options.

Errors and rejections

When no profile or multiple profiles match, or the selected value is blank.

Public members

`groups[].profiles`

Optional provider connection profile list; an absent list contributes no candidates to exact TCPS selection.

Example

import { selectAdbConnectionProfile } from '@alneas/eaos-cli/presets/oci-adb/infra/database'
export function connection(groups: Parameters<typeof selectAdbConnectionProfile>[0]) { return selectAdbConnectionProfile(groups) }

[FUNCTION] `selectImage`

Select one exact display-name image or deterministically choose the newest compatible image.

Imports: @alneas/eaos-cli/presets/oci-adb/infra/lookups.

Signature

declare function selectImage(images: readonly ImageCandidate[], selection: 'exact' | 'latest', displayName?: string): string;

Parameters

Name	Type	Required	Description
`images`	`readonly ImageCandidate[]`	Yes	Candidate IDs, display names and creation timestamps from the provider.
`selection`	`'exact' \| 'latest'`	Yes	exact requires exactly one named candidate; latest sorts descending by parsed creation time and then ID.
`displayName`	`string`	No	Required nonempty name for exact selection; ignored for latest selection.

Returns

string

Selected nonempty image ID.

Errors and rejections

If selection is invalid, candidates are absent/ambiguous, latest timestamps are invalid or the selected ID is empty.

Example

import { selectImage } from '@alneas/eaos-cli/presets/oci-adb/infra/lookups'
const imageId = selectImage([{ id: 'example-image', displayName: 'reviewed', timeCreated: '2026-01-01T00:00:00Z' }], 'exact', 'reviewed')

[FUNCTION] `selectOciAdbConnectionString`

Resolve the selected provider connection profile from an Autonomous Database Output.

Imports: @alneas/eaos-cli/presets/oci-adb/infra, @alneas/eaos-cli/presets/oci-adb/infra/database.

Signature

declare function selectOciAdbConnectionString(database: Pick<oci.database.AutonomousDatabase, 'connectionStrings'>, selection?: OciAdbConnectionSelection): pulumi.Output<string>;

Parameters

Name	Type	Required	Description
`database`	`Pick<oci.database.AutonomousDatabase, 'connectionStrings'>`	Yes	Resource reference exposing provider-supplied connectionStrings.
`selection`	`OciAdbConnectionSelection`	No	Copied filter settings; defaults are those of selectAdbConnectionProfile.

Returns

pulumi.Output<string>

A Pulumi Output resolving to the unchanged matching DSN.

Remarks

Does not mark its return secret itself; hosts must wrap sensitive connection values when exporting or storing them.

Errors and rejections

Provider Output failures and unmatched/ambiguous profiles reject during resolution.

Example

import { selectOciAdbConnectionString } from '@alneas/eaos-cli/presets/oci-adb/infra'
export function connection(database: Parameters<typeof selectOciAdbConnectionString>[0]) { return selectOciAdbConnectionString(database) }

[FUNCTION] `selectServiceNetwork`

Select exactly one regional All Services Oracle network from provider results.

Imports: @alneas/eaos-cli/presets/oci-adb/infra/lookups.

Signature

declare function selectServiceNetwork(services: readonly {
    id: string;
    name: string;
    cidrBlock: string;
}[]): OciServiceNetwork;

Parameters

Name	Type	Required	Description
`services`	`readonly { id: string; name: string; cidrBlock: string; }[]`	Yes	Provider service records with ID, display name and CIDR label.

Returns

OciServiceNetwork

The matching network ID and regional CIDR label.

Errors and rejections

When there is not exactly one matching network with a nonempty ID and CIDR label.

Public members

`services[].id`

Provider service network identity returned when this is the unique matching regional All Services entry.

`services[].name`

Provider display name matched against the regional All Services In Oracle Services Network pattern.

`services[].cidrBlock`

Provider regional service-network CIDR label retained exactly in the selected result.

Example

import { selectServiceNetwork } from '@alneas/eaos-cli/presets/oci-adb/infra/lookups'
const network = selectServiceNetwork([{ id: 'example-service', name: 'All Example Services In Oracle Services Network', cidrBlock: 'example-services' }])

[INTERFACE] `ServiceDefinition`

Rendered application/accessory/migration service configuration shared by Compose and Kamal outputs.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/render.

Signature

interface ServiceDefinition {
    name: string;
    image: string;
    command?: string[];
    environment?: Record<string, string>;
    files?: Array<{
        source: string;
        target: string;
    }>;
    runtimeFiles?: Array<{
        binding: string;
        target: string;
    }>;
    ports?: string[];
    dependsOn?: Record<string, {
        condition: 'service_healthy';
    }>;
    healthcheck?: {
        test: string[];
        interval: string;
        timeout: string;
        retries: number;
    };
    volume?: {
        source: string;
        target: string;
    };
    role: 'app' | 'accessory' | 'migration';
}

Parameters

Name	Type	Required	Description
`name`	`string`	Yes	Stable service name used for generated dependency and role configuration.
`image`	`string`	Yes	Selected container image; actual execution requires a reviewed immutable version.
`command`	`string[]`	No	Optional explicit argument vector for the service command.
`environment`	`Record<string, string>`	No	Non-secret generated environment values; credentials belong in trusted runtime bindings.
`files`	`Array<{ source: string; target: string; }>`	No	Generated file mounts with source and container target paths.
`runtimeFiles`	`Array<{ binding: string; target: string; }>`	No	Host-owned sensitive/runtime file bindings and their container targets.
`ports`	`string[]`	No	Explicit host/container port mappings rendered for the selected transport.
`dependsOn`	`Record<string, { condition: 'service_healthy'; }>`	No	Dependencies whose service_healthy condition gates startup.
`healthcheck`	`{ test: string[]; interval: string; timeout: string; retries: number; }`	No	Explicit test argv, interval, timeout and retry count.
`volume`	`{ source: string; target: string; }`	No	Optional persistent volume source and container mount target.
`role`	`'app' \| 'accessory' \| 'migration'`	Yes	Application, accessory or migration role used to render the correct lifecycle behavior.

Returns

Type declaration; no runtime value.

Public members

`name`

Stable service name used for generated dependency and role configuration.

`image`

Selected container image; actual execution requires a reviewed immutable version.

`command`

Optional explicit argument vector for the service command.

`environment`

Non-secret generated environment values; credentials belong in trusted runtime bindings.

`files`

Generated file mounts with source and container target paths.

`files[].source`

Generated configuration filename beneath the platform output, rendered as a read-only container mount.

`files[].target`

Container destination path for the generated configuration mount.

`runtimeFiles`

Host-owned sensitive/runtime file bindings and their container targets.

`runtimeFiles[].binding`

Host runtime-binding key resolved to a trusted file/directory path during rendering.

`runtimeFiles[].target`

Container destination path receiving the bound host file/directory.

`ports`

Explicit host/container port mappings rendered for the selected transport.

`dependsOn`

Dependencies whose service_healthy condition gates startup.

`dependsOn.condition`

Require the dependency to become service_healthy before starting this service.

`healthcheck`

Explicit test argv, interval, timeout and retry count.

`healthcheck.test`

Container health-check command vector.

`healthcheck.interval`

Container duration string between checks.

`healthcheck.timeout`

Container duration string limiting one check.

`healthcheck.retries`

Failed-check count used by the container health configuration.

`volume`

Optional persistent volume source and container mount target.

`volume.source`

Named persistent volume identifier rendered into the service mount.

`volume.target`

Container mount path at which the persistent volume is attached.

`role`

Application, accessory or migration role used to render the correct lifecycle behavior.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `SiteOperationsConfig`

Explicit catalog of sites and the host-selected Bun executable.

Imports: @alneas/eaos-cli/site.

Signature

interface SiteOperationsConfig {
    bunPath?: string;
    sites: LocalSiteProfile[];
}

Parameters

Name	Type	Required	Description
`bunPath`	`string`	No	Absolute trusted Bun executable path; local site execution requires this registration.
`sites`	`LocalSiteProfile[]`	Yes	Explicit list of at most 100 uniquely identified site registrations.

Returns

Type declaration; no runtime value.

Public members

`bunPath`

Absolute trusted Bun executable path; local site execution requires this registration.

`sites`

Explicit list of at most 100 uniquely identified site registrations.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[INTERFACE] `SiteRunReceipt`

Immutable outcome and artifact references from a bounded registered site run.

Imports: @alneas/eaos-cli/site.

Signature

interface SiteRunReceipt {
    id: string;
    siteId: string;
    kind: 'build' | 'preview';
    outcome: 'succeeded' | 'failed' | 'stopped';
    startedAt: string;
    finishedAt: string;
    packageHash: string;
    snapshotHash?: string;
    previewUrl?: string;
    logFile: string;
}

Parameters

Name	Type	Required	Description
`id`	`string`	Yes	Unique run UUID used for the private log/receipt directory.
`siteId`	`string`	Yes	Registered site key selected for this run.
`kind`	`'build' \| 'preview'`	Yes	Whether the registered build or preview script was selected.
`outcome`	`'succeeded' \| 'failed' \| 'stopped'`	Yes	succeeded for completed build, stopped for a ready preview ended by its deadline/cancellation, otherwise failed.
`startedAt`	`string`	Yes	UTC ISO timestamp captured when execution begins.
`finishedAt`	`string`	Yes	UTC ISO timestamp captured after process cleanup.
`packageHash`	`string`	Yes	SHA-256 of serialized package metadata used to select scripts.
`snapshotHash`	`string`	No	Optional SHA-256 of the exact staged snapshot bytes.
`previewUrl`	`string`	No	Loopback URL included only after the preview becomes ready.
`logFile`	`string`	Yes	Path to the retained redacted run log; no log content is embedded in this receipt.

Returns

Type declaration; no runtime value.

Public members

`id`

Unique run UUID used for the private log/receipt directory.

`siteId`

Registered site key selected for this run.

`kind`

Whether the registered build or preview script was selected.

`outcome`

succeeded for completed build, stopped for a ready preview ended by its deadline/cancellation, otherwise failed.

`startedAt`

UTC ISO timestamp captured when execution begins.

`finishedAt`

UTC ISO timestamp captured after process cleanup.

`packageHash`

SHA-256 of serialized package metadata used to select scripts.

`snapshotHash`

Optional SHA-256 of the exact staged snapshot bytes.

`previewUrl`

Loopback URL included only after the preview becomes ready.

`logFile`

Path to the retained redacted run log; no log content is embedded in this receipt.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `squashDatabaseContract`

Compile PostgreSQL or Oracle schema history in isolated local Docker databases and verify its rebuilt metadata.

Imports: @alneas/eaos-cli/baseline.

Signature

declare function squashDatabaseContract(contract: DataContract, dialect: 'postgres' | 'oracle', options?: DatabaseBaselineOptions): Promise<DatabaseBaselineCompilation>;

Parameters

Name	Type	Required	Description
`contract`	`DataContract`	Yes	Reviewed database-scoped migration contract with complete SQL for the selected dialect.
`dialect`	`'postgres' \| 'oracle'`	Yes	postgres or oracle; SQLite uses squashSqliteContract instead.
`options`	`DatabaseBaselineOptions`	No	Optional digest-pinned preloaded images and startup timeout; see DatabaseBaselineOptions.

Returns

Promise<DatabaseBaselineCompilation>

Final SQL statements and immutable image/schema rebuild verification metadata.

Remarks

Starts disposable local containers/volumes and removes owned resources in cleanup. Never accepts a production DSN, existing container, host mount or published database port; images must already be acquired.

Errors and rejections

Rejects unsupported history, nonlocal Docker contexts, unavailable/nonpinned images, unsupported objects, seeded data, startup timeouts or metadata mismatch.

Example

import { squashDatabaseContract } from '@alneas/eaos-cli/baseline'
export function compilePostgres(contract: Parameters<typeof squashDatabaseContract>[0]) { return squashDatabaseContract(contract, 'postgres') }

[FUNCTION] `squashSqliteContract`

Compile database-scoped SQLite migration history into a schema-only baseline and verify an independent rebuild.

Imports: @alneas/eaos-cli/baseline.

Signature

declare function squashSqliteContract(contract: DataContract): string[];

Parameters

Name	Type	Required	Description
`contract`	`DataContract`	Yes	Reviewed Data Contract whose migrations contain complete SQLite DDL.

Returns

string[]

Final schema SQL ordered by tables, indexes, views, then other objects, preserving SQLite schema row order within each group.

Remarks

Runs trusted SQL in temporary in-memory node:sqlite databases and closes them. It does not touch a live database or rebase an existing ledger.

Errors and rejections

Rejects missing dialect SQL, external-database operations, virtual/empty schemas, seeded rows and rebuild mismatches.

Example

import { squashSqliteContract } from '@alneas/eaos-cli/baseline'
export function compileSqlite(contract: Parameters<typeof squashSqliteContract>[0]) { return squashSqliteContract(contract) }

[FUNCTION] `stagePlatformPackages`

Copy only registered, checksum-verified assets into a fresh image staging tree.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/packages.

Signature

declare function stagePlatformPackages(root: string, directory: string, config?: string): Promise<{
    directory: string;
    packages: number;
    activated: boolean;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted application root.
`directory`	`string`	Yes	Separate empty staging destination.
`config`	`string`	No	Workspace-relative manifest path; defaults to eaos.platform.json.

Returns

Promise<{ directory: string; packages: number; activated: boolean; }>

The staging directory, copied package count and activated=false.

Remarks

Uses exclusive file creation and does not execute package modules; a failed staging attempt may leave partial files for inspection.

Errors and rejections

Rejects reused destinations, changed hashes, invalid paths/registrations or filesystem errors.

Example

import { stagePlatformPackages } from '@alneas/eaos-cli/platform'
export function stageImage(root: string, directory: string) { return stagePlatformPackages(root, directory) }

[FUNCTION] `startPluginDev`

Load a trusted local plugin entry and start its loopback development server.

Imports: @alneas/eaos-cli/dev.

Signature

declare function startPluginDev(cwd: string, options: {
    config: string;
    port: string;
}): Promise<{
    server: any;
    close: () => Promise<never>;
}>;

Parameters

Name	Type	Required	Description
`cwd`	`string`	Yes	Trusted plugin project root.
`options`	`{ config: string; port: string; }`	Yes	Required config path resolved against cwd and required port text converted with Number; the port must be an integer from 1024 to 65535.

Returns

Promise<{ server: any; close: () => Promise<never>; }>

Resolves to the loopback server and close() handler; close stops the server, cleans disposable state and exits the current process with code 0.

Remarks

Requires Bun. Executes trusted local source, binds 127.0.0.1, and rejects mismatched Host or Origin values; local callers can select the development persona headers. It is not an OS sandbox or production authentication. SIGINT/SIGTERM handlers call the same close function, which exits the whole process after cleanup; embedding hosts must account for this ownership.

Errors and rejections

Rejects invalid ports/configuration, module import failures or local server/resource initialization failures.

Public members

`options.config`

Trusted plugin configuration module path resolved against cwd and dynamically imported; typically eaos.dev.ts.

`options.port`

Required decimal port text converted with Number; must become an integer from 1024 to 65535.

Example

import { startPluginDev } from '@alneas/eaos-cli/dev'
export function startLocal(root: string) { return startPluginDev(root, { config: 'eaos.dev.ts', port: '4310' }) }

[FUNCTION] `syncAgentsMd`

Synchronize only the generated metadata block of a plugin AGENTS.md file.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/commands/sync-agents-md.

Signature

declare function syncAgentsMd(root: string, options: CommandOptions): Promise<void>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Trusted workspace root.
`options`	`CommandOptions`	Yes	plugin is required; check performs equality verification without writing.

Returns

Promise<void>

Resolves without a value when the document matches or has been updated.

Remarks

Preserves text outside the generated block and does not alter unrelated agent instructions.

Errors and rejections

Rejects symlink documents, unresolved inspected contracts, malformed blocks, stale checks or filesystem failures.

Example

import { syncAgentsMd } from '@alneas/eaos-cli/plugin-tools'
export async function checkAgents(root: string) { await syncAgentsMd(root, { plugin: 'notes', check: true }) }

[FUNCTION] `syncRoutes`

Generate registered client route entries while protecting edited or unmanaged output.

Imports: @alneas/eaos-cli/commands/sync-routes.

Signature

declare function syncRoutes(options?: SyncRoutesOptions): Promise<void>;

Parameters

Name	Type	Required	Description
`options`	`SyncRoutesOptions`	No	config defaults to eaos.clients.json; target defaults to web, dest selects the generated directory, check verifies exact output and prune is rejected.

Returns

Promise<void>

Resolves without a value after equality verification or writing the route registry and receipt.

Remarks

Uses process.cwd() as the project root. Inspects declared client manifests and writes build-time composition only; generated routes do not grant runtime access.

Errors and rejections

Rejects invalid inventory, protected/stale outputs and filesystem errors.

Example

import { syncRoutes } from '@alneas/eaos-cli/commands/sync-routes'
await syncRoutes({ target: 'web', check: true })

[INTERFACE] `SyncRoutesOptions`

Client catalog, output and verification controls resolved relative to process.cwd().

Imports: @alneas/eaos-cli/commands/sync-routes.

Signature

interface SyncRoutesOptions {
    config?: string;
    dest?: string;
    target?: string;
    check?: boolean;
    prune?: boolean;
}

Parameters

Name	Type	Required	Description
`config`	`string`	No	Relative explicit client catalog path; defaults to eaos.clients.json in process.cwd().
`dest`	`string`	No	Relative generated directory; defaults to the selected web/LINE frontend generated tree.
`target`	`string`	No	web by default, or line; other targets are rejected.
`check`	`boolean`	No	Verify exact registry and ownership receipt without writing.
`prune`	`boolean`	No	Unsupported legacy request; true is rejected rather than deleting copied sources.

Returns

Type declaration; no runtime value.

Public members

`config`

Relative explicit client catalog path; defaults to eaos.clients.json in process.cwd().

`dest`

Relative generated directory; defaults to the selected web/LINE frontend generated tree.

`target`

web by default, or line; other targets are rejected.

`check`

Verify exact registry and ownership receipt without writing.

`prune`

Unsupported legacy request; true is rejected rather than deleting copied sources.

Example

See the owning declaration and linked feature guide for usage; no standalone example is documented in source.

[FUNCTION] `unregisterPlatformPackage`

Remove a package code registration only after every owned plugin is uninstalled and disabled.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/packages.

Signature

declare function unregisterPlatformPackage(root: string, id: string, store: LifecycleStore, config?: string): Promise<{
    id: string;
    retainedArtifacts: boolean;
    retainedDatabase: boolean;
    restartRequired: boolean;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Application workspace root.
`id`	`string`	Yes	Exact registered package identity.
`store`	`LifecycleStore`	Yes	Shared Lifecycle store used to inspect installations/activations under its writer lock.
`config`	`string`	No	Workspace-relative manifest path; defaults to eaos.platform.json.

Returns

Promise<{ id: string; retainedArtifacts: boolean; retainedDatabase: boolean; restartRequired: boolean; }>

Removed identity and flags confirming retained artifacts/database plus restartRequired.

Remarks

Retains database records, lifecycle history and artifact files. Do not infer deletion from code unregistration.

Errors and rejections

Rejects missing registrations, remaining installations/enabled activations, lock contention or store/filesystem failures.

Example

import { unregisterPlatformPackage } from '@alneas/eaos-cli/platform'
export function unregisterReviewed(root: string, id: string, store: Parameters<typeof unregisterPlatformPackage>[2]) { return unregisterPlatformPackage(root, id, store) }

[FUNCTION] `upPlatform`

Start the configured local Compose application after reviewing its generated runtime contract.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/operations.

Signature

declare function upPlatform(root: string, options?: {
    config?: string;
    plan?: boolean;
}, run?: OperationRunner): Promise<{
    mode: string;
    command: string;
    argv: string[];
    status?: undefined;
} | {
    status: string;
    mode?: undefined;
    command?: undefined;
    argv?: undefined;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Existing application project root.
`options`	`{ config?: string; plan?: boolean; }`	No	plan returns the startup plan without host execution.
`run`	`OperationRunner`	No	Optional trusted argv-only command runner; defaults to the real subprocess runner.

Returns

Promise<{ mode: string; command: string; argv: string[]; status?: undefined; } \| { status: string; mode?: undefined; command?: undefined; argv?: undefined; }>

The startup plan or local operation result after configured steps succeed.

Remarks

Actual mode starts host processes/containers and may execute configured local setup operations. Existing credentials and volumes are not silently replaced.

Errors and rejections

Rejects invalid startup contracts, missing password/TLS files, stale generated configuration or failed build/start/readiness commands.

Public members

`options.config`

Workspace-relative application manifest used for generation and startup contract checks; defaults to eaos.platform.json.

`options.plan`

When true, return Docker startup argv without executing generation or subprocess startup; false/omitted runs the reviewed local startup steps.

Example

import { upPlatform } from '@alneas/eaos-cli/platform'
export function inspectLocal(root: string) { return upPlatform(root, { plan: true }) }

[FUNCTION] `verifyPlatformPackages`

Verify package registrations against inventory assets and optional runtime database targets.

Imports: @alneas/eaos-cli/platform, @alneas/eaos-cli/platform/packages.

Signature

declare function verifyPlatformPackages(root: string, packages: PlatformPackage[], runtime?: PlatformRuntimeConfig): Promise<{
    databaseTargets: _alneas_eaos_server_lifecycle_engine.BackendTarget[];
    contributions: {
        tenantDatabases: {
            tenantId: string;
            targetId: string;
            databaseId: string;
        }[];
        owner: string;
        artifact: string;
        inventorySha256: string;
        runtime?: string;
        functions: DeploymentInventory["functions"];
        database?: DeploymentInventory["database"];
        plugins: DeploymentInventory["plugins"];
        coverage: "declared" | "legacy-unclassified";
        verifiedAssets: number;
    }[];
    databasePolicy: string;
    componentPlacements?: {
        owner: string;
        pluginId: string;
        componentId: string;
        destinationIds: string[];
        adopted: boolean;
    }[] | undefined;
    destinations?: _alneas_eaos_server_platform.DeploymentDestination[] | undefined;
    mode: string;
}>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Application workspace root.
`packages`	`PlatformPackage[]`	Yes	Explicit package registrations to verify.
`runtime`	`PlatformRuntimeConfig`	No	Optional runtime catalog for tenant-to-database checks.

Returns

Promise<{ databaseTargets: _alneas_eaos_server_lifecycle_engine.BackendTarget[]; contributions: { tenantDatabases: { tenantId: string; targetId: string; databaseId: string; }[]; owner: string; artifact: string; inventorySha256: string; runtime?: string; functions: DeploymentInventory["functions"]; database?: DeploymentInventory["database"]; plugins: DeploymentInventory["plugins"]; coverage: "declared" \| "legacy-unclassified"; verifiedAssets: number; }[]; databasePolicy: string; componentPlacements?: { owner: string; pluginId: string; componentId: string; destinationIds: string[]; adopted: boolean; }[] \| undefined; destinations?: _alneas_eaos_server_platform.DeploymentDestination[] \| undefined; mode: string; }>

The verified deployment plan with each contribution annotated by tenant database targets.

Remarks

Does not execute registered modules or migrate a database.

Errors and rejections

Rejects invalid registrations, runtime/lifecycle mismatches, hash failures or inconsistent database targets.

Example

import { verifyPlatformPackages } from '@alneas/eaos-cli/platform'
export function verifyHost(root: string, packages: Parameters<typeof verifyPlatformPackages>[1]) { return verifyPlatformPackages(root, packages) }

[FUNCTION] `writeContractBaseline`

Create an immutable schema-baseline directory with archived source and per-dialect rebuild evidence.

Imports: @alneas/eaos-cli/baseline.

Signature

declare function writeContractBaseline(cwd: string, options: {
    contract: string;
    version: string;
    out: string;
} & DatabaseBaselineOptions): Promise<{
    hash: string;
    path: string;
    sourcePreserved: boolean;
}>;

Parameters

Name	Type	Required	Description
`cwd`	`string`	Yes	Trusted workspace root for contract and output containment.
`options`	`{ contract: string; version: string; out: string; } & DatabaseBaselineOptions`	Yes	Required relative contract path, newer target version and new output directory; optional local compiler image/time settings.

Returns

Promise<{ hash: string; path: string; sourcePreserved: boolean; }>

The baseline hash, final directory and sourcePreserved=true.

Remarks

May start disposable local Docker databases for PostgreSQL/Oracle. Writes only release artifacts; does not apply/rebase a host database or activate tenants.

Errors and rejections

Rejects existing output, unsafe paths, invalid versions/dialects or compilation failures; an incomplete stage may remain for inspection.

Public members

`options.contract`

Workspace-relative canonical source contract JSON path, preserved as archived evidence.

`options.version`

Valid target semantic version strictly newer than the source contract release.

`options.out`

New workspace-relative output directory for baseline contract, SQL and compiler verification; an existing output is rejected.

Example

import { writeContractBaseline } from '@alneas/eaos-cli/baseline'
export function compileRelease(root: string) { return writeContractBaseline(root, { contract: 'contracts/notes.json', version: '1.1.0', out: 'releases/notes-1.1.0' }) }

[FUNCTION] `writeDraft`

Write a generated draft or check exact equality without replacing a protected existing draft.

Imports: @alneas/eaos-cli/plugin-tools, @alneas/eaos-cli/plugin-tools/utils.

Signature

declare function writeDraft(file: string, content: string, options: CommandOptions): void;

Parameters

Name	Type	Required	Description
`file`	`string`	Yes	Destination file, resolved by the trusted caller.
`content`	`string`	Yes	Complete desired UTF-8 content.
`options`	`CommandOptions`	Yes	check compares without writing; otherwise write must be true to replace an existing file.

Returns

void

No value; the draft matches or has been written.

Remarks

Creates parent directories when writing; does not establish containment or inspect symlink components itself.

Errors and rejections

When check finds missing/stale content, replacement lacks write, or filesystem access fails.

Example

import { writeDraft } from '@alneas/eaos-cli/plugin-tools'
export function checkDraft(file: string, content: string) { writeDraft(file, content, { check: true }) }

[FUNCTION] `writeInventory`

Hash staging files and write a validated, bounded deployment inventory.

Imports: @alneas/eaos-cli/platform/deployment-assets.

Signature

declare function writeInventory(root: string, inventory: DeploymentInventory, paths: string[]): Promise<DeploymentInventory>;

Parameters

Name	Type	Required	Description
`root`	`string`	Yes	Isolated built package staging root.
`inventory`	`DeploymentInventory`	Yes	Mutable inventory object; its assets list is replaced with computed hashes.
`paths`	`string[]`	Yes	Relative files to hash; deployment.json itself is excluded.

Returns

Promise<DeploymentInventory>

The validated inventory after writing deployment.json.

Remarks

Mutates inventory.assets and writes staging metadata; the caller must provide contained paths, not arbitrary user input.

Errors and rejections

Rejects nonfiles, malformed plugin metadata, inventories over 1 MiB and filesystem failures.

Example

import { writeInventory } from '@alneas/eaos-cli/platform/deployment-assets'
export function writeStagedInventory(root: string, inventory: Parameters<typeof writeInventory>[1], paths: string[]) { return writeInventory(root, inventory, paths) }

[CONSTANT] `writeSqliteBaseline`

Forward the legacy SQLite-named baseline entry to the current all-dialect compiler.

Imports: @alneas/eaos-cli/baseline.

Signature

declare const writeSqliteBaseline: typeof writeContractBaseline;

Parameters

Name	Type	Required	Description
—	—	—	No call parameters.

Returns

Declared constant value.

The baseline hash, final directory and sourcePreserved=true.

Remarks

Compatibility entry for writeContractBaseline; compiles every declared supported dialect, not just SQLite. It does not change the canonical implementation.

Errors and rejections

Rejects existing output, unsafe paths, invalid versions/dialects or compilation failures; an incomplete stage may remain for inspection.

Example

import { writeSqliteBaseline } from '@alneas/eaos-cli/baseline'
export function compileRelease(root: string) { return writeSqliteBaseline(root, { contract: 'contracts/notes.json', version: '1.1.0', out: 'releases/notes-1.1.0' }) }

@alneas/eaos-cli API

@alneas/eaos-cli API

Public entrypoints

[INTERFACE] AdbConnectionProfile

Signature

Parameters

Returns

See also

Public members

consumerGroup

tlsAuthentication

protocol

hostFormat

syntaxFormat

sessionMode

isRegional

displayName

value

Example

[FUNCTION] agentDocumentNext

Signature

Parameters

Returns

Remarks

Errors and rejections

Example

[FUNCTION] assertPluginId

Signature

Parameters

Returns

Errors and rejections

Example

[CONSTANT] baselineImages

Signature

Parameters

Returns

See also

Example

[FUNCTION] callSiteControl

Signature

Parameters

Returns

Remarks

Errors and rejections

Example

[FUNCTION] checkContracts

Signature

Parameters

Returns

Remarks

Errors and rejections

Example

[FUNCTION] checkLocalSite

Signature

Parameters

Returns

Remarks

Errors and rejections

Example

[CONSTANT] cliVersion

Signature

Parameters

Returns

See also

Example

[INTERFACE] CommandOptions

Signature

Parameters

Returns

See also

Public members

plugin

check

write

autoFix

name

description

industry

tier

addonId

[INTERFACE] `AdbConnectionProfile`

`consumerGroup`

`tlsAuthentication`

`protocol`

`hostFormat`

`syntaxFormat`

`sessionMode`

`isRegional`

`displayName`

`value`

[FUNCTION] `agentDocumentNext`

[FUNCTION] `assertPluginId`

[CONSTANT] `baselineImages`

[FUNCTION] `callSiteControl`

[FUNCTION] `checkContracts`

[FUNCTION] `checkLocalSite`

[CONSTANT] `cliVersion`

[INTERFACE] `CommandOptions`

`plugin`

`check`

`write`

`autoFix`

`name`

`description`

`industry`

`tier`

`addonId`

`monthlyQuota`

`allowedTenants`

`targets`

`features`

`output`

`format`

`against`

[INTERFACE] `ContractCheckOptions`

`against`

[FUNCTION] `createDeploymentPlan`

`options.placements`

[FUNCTION] `createOciAdbPreset`

[FUNCTION] `createOciAuthToken`

[FUNCTION] `createOciAutonomousDatabase`

[FUNCTION] `createOciBastion`

[FUNCTION] `createOciCompute`

[FUNCTION] `createOciNetwork`

[FUNCTION] `createOciNetworkLoadBalancer`