close
Skip to main content
Home
PackagesDocsSign in

@sys/tools@0.0.496
Built and signed on GitHub Actions

latest
sys-repo/sys
Works with
This package works with Deno, Browsers
This package works with Deno
This package works with Browsers
•JSR Score100%•
License
MIT
•
Downloads5/wk
•
Published2 weeks ago (0.0.496)

CLI surface for @sys primitive compositions.

default

Variables

v
pkg: Pkg

Package metadata.

env

Functions

f
env(options?: EnvOptions): Promise<void>

Ensure environment is initialized for the current runtime.

Type Aliases

T
EnvOptions = { vscode?: boolean; silent?: boolean; }

Options for the env runtime initializer.

  • silent: boolean

    Suppress initializer output.

  • vscode: boolean

    Initialize VSCode terminal environment support.

copy

Functions

f
cli(
cwd,
argv
)
No documentation available

Variables

v
ClipboardTools: t.ClipboardToolsLib

Programmatic clipboard helpers for the @sys/tools/cp surface.

crdt

Functions

f
cli(
cwd,
argv
)

Main entry:

deploy

Functions

f
cli(
cwd,
argv
)

Main entry:

Namespaces

N
DeployTool

Tools for deploying files to a publishing endpoint (CDN).

N
DeployTool.Config
No documentation available
N
DeployTool.Config.EndpointYaml

YAML-authored endpoint configuration (authoritative). (We keep these types here so callers can share the same vocabulary.)

N
DeployTool.Config.Provider

Deployment provider configuration.

N
DeployTool.Endpoint
No documentation available
N
DeployTool.Endpoint.Fs

Filesystem conventions for endpoint YAML storage.

N
DeployTool.Endpoint.Menu
No documentation available
N
DeployTool.PushOperation
No documentation available
N
DeployTool.StageOperation
No documentation available
N
DeployTool.Staging
No documentation available

Type Aliases

T
DeployTool.CliAction = "stage" | "push" | "stage+push"

Command line arguments (argv).

T
DeployTool.CliArgs =
t.Tools.CliArgs
& { config?: string; action?: CliAction; non-interactive?: boolean; force?: boolean; }
No documentation available
T
DeployTool.CliParsedArgs = t.ParsedArgs<CliArgs> & { interactive: boolean; }
No documentation available
T
DeployTool.Command = "back" | "exit"

Command names.

T
DeployTool.Config.Doc =
t.JsonFile.Doc
& { name: string; endpoints?: readonly EndpointRef[]; }
No documentation available
T
DeployTool.Config.EndpointRef = t.Tools.Recency & { name: string; file: t.StringPath; }

An endpoint reference tracked in config.json for recency + lookup. The endpoint's actual configuration is authored in YAML.

T
DeployTool.Config.EndpointYaml.Doc = { provider?: Provider.All; source?: Source; staging?: Staging; mappings?: readonly Mapping[]; }
No documentation available
  • mappings: readonly Mapping[]

    Directory mappings assembled into this endpoint.

  • provider: Provider.All

    Optional provider adapter config.

  • source: Source

    Source root for this endpoint.

  • staging: Staging

    Staging root for this endpoint.

T
DeployTool.Config.EndpointYaml.Mapping = { dir: { source: t.StringDir; staging: "." | t.StringPath; }; mode: SourceMode; shards?: { total: number; requireAll?: boolean; }; }

Maps an input directory into the generated endpoint staging dir. (Source may be absolute or relative; resolution rules are handled by runtime.)

  • dir: { source: t.StringDir; staging: "." | t.StringPath; }
    No documentation available
  • mode: SourceMode
    No documentation available
  • shards: { total: number; requireAll?: boolean; }

    Optional shard expansion for template paths. When provided and templates are present, mappings are expanded per shard.

T
DeployTool.Config.EndpointYaml.Source = { dir: t.StringPath; }

Endpoint source root. Mapping dir.source values are resolved relative to this directory.

  • dir: t.StringPath

    Root directory for sources (relative to deploy cwd).

T
DeployTool.Config.EndpointYaml.SourceMode = "copy" | "build+copy" | "index"

Canonical per-mapping behavior.

T
DeployTool.Config.EndpointYaml.Staging = { dir: t.StringPath; clear?: boolean; serve?: { port?: number; }; html?: { buildReset?: boolean; }; }

Endpoint staging root. All mapping dir.staging paths are resolved relative to this directory.

  • clear: boolean

    When true, clears staging targets before running mappings.

  • dir: t.StringPath

    Root directory for staging (relative to deploy cwd).

  • html: { buildReset?: boolean; }

    Optional HTML staging policies.

  • serve: { port?: number; }

    Optional local serve configuration for staged endpoint sanity checks.

T
DeployTool.Config.File = t.JsonFile.Instance<Doc>
No documentation available
T
DeployTool.Config.Provider.All = Orbiter | Noop | R2

Tagged union of all supported provider configs. Add new providers here (and in u.providers schemas) as they land.

T
DeployTool.Config.Provider.Noop = t.NoopProvider
No documentation available
T
DeployTool.Config.Provider.Orbiter = t.OrbiterProvider
No documentation available
T
DeployTool.Config.Provider.R2 = t.R2Provider
No documentation available
T
DeployTool.Endpoint.Fs.DirName = `-config/${string}.deploy`
No documentation available
T
DeployTool.Endpoint.Fs.Ext = ".yaml"
No documentation available
T
DeployTool.Endpoint.Fs.YamlCheck =
{ readonly ok: true; readonly doc: t.DeployTool.Config.EndpointYaml.Doc; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }
No documentation available
T
DeployTool.Endpoint.Menu.Action =
"stage"
| "push"
| "stage-push"
| "serve"
| "edit"
| "reload"
| "fix"
| "rename"
| "delete"
| "back"
No documentation available
T
DeployTool.Endpoint.Menu.Option = { readonly name: string; readonly value: Action; }
No documentation available
  • name: string
    No documentation available
  • value: Action
    No documentation available
T
DeployTool.Endpoint.RunAction = Extract<Menu.Action, "stage" | "push" | "stage-push" | "serve">
No documentation available
T
DeployTool.Endpoint.RunResult = { readonly ok: boolean; readonly stageOk?: boolean; readonly push?: { readonly ok: boolean; readonly elapsed?: string; readonly shards?: number; readonly bytes?: number; readonly publish?: t.PushPublishStats; readonly prune?: t.PushPruneStats; }; readonly error?: unknown; }
No documentation available
  • error: unknown
    No documentation available
  • ok: boolean
    No documentation available
  • push: { readonly ok: boolean; readonly elapsed?: string; readonly shards?: number; readonly bytes?: number; readonly publish?: t.PushPublishStats; readonly prune?: t.PushPruneStats; }
    No documentation available
  • stageOk: boolean
    No documentation available
T
DeployTool.Id = ID
No documentation available
T
DeployTool.Lib = { stage(args: StageArgs): Promise<StageResult>; push(args: PushArgs): Promise<PushResult>; }

Public deploy helper API.

  • push(args: PushArgs): Promise<PushResult>

    Push an already-staged endpoint from owner YAML.

  • stage(args: StageArgs): Promise<StageResult>

    Stage endpoint files from owner YAML.

T
DeployTool.MenuOption = { name: string; value: Command; }
No documentation available
  • name: string
    No documentation available
  • value: Command
    No documentation available
T
DeployTool.Name = NAME
No documentation available
T
DeployTool.PushArgs =
{ readonly cwd?: t.StringDir; readonly force?: boolean; }
& t.Tools.ConfigRefArgs
No documentation available
T
DeployTool.PushOperation.Failure = { readonly ok: false; readonly cwd: t.StringDir; readonly config: t.StringPath; readonly reason:
"yaml-invalid"
| "no-provider"
| "no-push-targets"
| "no-staging-output"
| "probe-failed"
| "unsupported-provider"
| "not-implemented"
| "failed"
; readonly hint?: string; readonly target?: t.PushTargetContext; readonly missing?: readonly t.PushMissingTarget[]; readonly error?: unknown; }
No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • error: unknown
    No documentation available
  • hint: string
    No documentation available
  • missing: readonly t.PushMissingTarget[]
    No documentation available
  • ok: false
    No documentation available
  • reason:
    "yaml-invalid"
    | "no-provider"
    | "no-push-targets"
    | "no-staging-output"
    | "probe-failed"
    | "unsupported-provider"
    | "not-implemented"
    | "failed"
    No documentation available
  • target: t.PushTargetContext
    No documentation available
T
DeployTool.PushOperation.Result = PushResult | Failure
No documentation available
T
DeployTool.PushResult = { readonly ok: true; readonly cwd: t.StringDir; readonly config: t.StringPath; readonly targets: number; readonly elapsed?: string; readonly shards?: number; readonly bytes?: number; readonly publish?: t.PushPublishStats; readonly prune?: t.PushPruneStats; }
No documentation available
  • bytes: number
    No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • elapsed: string
    No documentation available
  • ok: true
    No documentation available
  • prune: t.PushPruneStats

    Provider-reported stale-file removals when available.

  • publish: t.PushPublishStats

    Provider-reported per-file publish details when available.

  • shards: number
    No documentation available
  • targets: number
    No documentation available
T
DeployTool.StageArgs = { readonly cwd?: t.StringDir; } & t.Tools.ConfigRefArgs
No documentation available
T
DeployTool.StageOperation.Failure = { readonly ok: false; readonly config: t.StringPath; readonly cwd: t.StringDir; readonly stagingRoot?: t.StringDir; readonly error?: unknown; }
No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • error: unknown
    No documentation available
  • ok: false
    No documentation available
  • stagingRoot: t.StringDir
    No documentation available
T
DeployTool.StageOperation.Result = StageResult | Failure
No documentation available
T
DeployTool.StageResult = { readonly ok: true; readonly config: t.StringPath; readonly cwd: t.StringDir; readonly stagingRoot: t.StringDir; }
No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • ok: true
    No documentation available
  • stagingRoot: t.StringDir
    No documentation available
T
DeployTool.Staging.Dir = { readonly source: t.StringDir; readonly staging: t.StringRelativeDir; }

Source → staging directory mapping.

  • source: t.StringDir
    No documentation available
  • staging: t.StringRelativeDir
    No documentation available
T
DeployTool.Staging.Mapping =
{ readonly mode: "copy"; readonly dir: Dir; }
| { readonly mode: "build+copy"; readonly dir: Dir; }
| { readonly mode: "index"; readonly dir: Dir; }

Staging operation.

T
DeployTool.Staging.ProgressEvent = { readonly kind: ProgressKind; readonly index: number; readonly total: number; readonly mode: t.DeployTool.Staging.Mapping["mode"]; readonly source: t.StringPath; readonly staging: t.StringPath; readonly label?: string; readonly error?: unknown; }
No documentation available
  • error: unknown
    No documentation available
  • index: number
    No documentation available
  • kind: ProgressKind
    No documentation available
  • label: string
    No documentation available
  • mode: t.DeployTool.Staging.Mapping["mode"]
    No documentation available
  • source: t.StringPath
    No documentation available
  • staging: t.StringPath
    No documentation available
  • total: number
    No documentation available
T
DeployTool.Staging.ProgressKind =
"mapping:start"
| "mapping:step"
| "mapping:done"
| "mapping:fail"

Build progress.

T
DeployTool.Staging.ProgressReport<K extends ProgressKind> = { readonly kind: K; readonly label: string; }
No documentation available
  • kind: K
    No documentation available
  • label: string
    No documentation available
T
DeployToolsLib = { cli(
cwd?: t.StringDir,
argv?: string[]
): Promise<void>; }

CLI helpers for working with Deploy.

  • cli(
    cwd?: t.StringDir,
    argv?: string[]
    ): Promise<void>

    Run the deploy CLI flow (interactive by default, strict with --non-interactive).

T
EndpointYamlFile = { readonly provider?: t.DeployTool.Config.Provider.All; readonly source?: { readonly dir: string; }; readonly staging?: { readonly dir: string; }; readonly mappings?: readonly t.DeployTool.Staging.Mapping[]; }

Parsed contents of an endpoint YAML file.

  • mappings: readonly t.DeployTool.Staging.Mapping[]
    No documentation available
  • provider: t.DeployTool.Config.Provider.All
    No documentation available
  • source: { readonly dir: string; }
    No documentation available
  • staging: { readonly dir: string; }
    No documentation available
T
NoopProvider = { kind: "noop"; }

No-op provider configuration.

  • kind: "noop"
    No documentation available
T
NoopPushTarget = { readonly provider: t.DeployTool.Config.Provider.Noop; readonly sourceDir: t.StringDir; readonly stagingDir?: t.StringDir; readonly shard?: number; readonly domain?: string; }

No-op provider target used to validate deploy flows without publishing.

  • domain: string
    No documentation available
  • provider: t.DeployTool.Config.Provider.Noop
    No documentation available
  • shard: number
    No documentation available
  • sourceDir: t.StringDir
    No documentation available
  • stagingDir: t.StringDir
    No documentation available
T
OrbiterConfig = { readonly siteId: string; readonly domain: string; readonly buildCommand: string; readonly buildDir: string; }

Formal configuration (orbiter.json).

  • buildCommand: string
    No documentation available
  • buildDir: string
    No documentation available
  • domain: string
    No documentation available
  • siteId: string
    No documentation available
T
OrbiterProvider = { kind: "orbiter"; siteId: string; domain: string; shards?: { total: number; only?: number[]; siteIds?: Record<number, t.StringUrl>; }; }

Orbiter provider configuration (YAML configuration).

  • domain: string

    Logical domain / bucket name (eg "fs").

  • kind: "orbiter"
    No documentation available
  • shards: { total: number; only?: number[]; siteIds?: Record<number, t.StringUrl>; }

    Optional shard deployment config. When present, shard-aware mappings can be expanded and validated.

  • siteId: string

    Stable site identifier used by Orbiter.

T
OrbiterPushTarget = { readonly provider: t.DeployTool.Config.Provider.Orbiter; readonly sourceDir: t.StringDir; readonly stagingDir: t.StringDir; readonly shard?: number; readonly domain?: string; }

Provider-specific push target.

  • domain: string
    No documentation available
  • provider: t.DeployTool.Config.Provider.Orbiter
    No documentation available
  • shard: number
    No documentation available
  • sourceDir: t.StringDir
    No documentation available
  • stagingDir: t.StringDir
    No documentation available
T
OrbiterPushTargetPlan = { readonly targets: readonly OrbiterPushTarget[]; readonly missing: readonly PushMissingTarget[]; readonly stats: OrbiterPushTargetStats; }

Orbiter-specific plan preserving shard-aware target statistics.

  • missing: readonly PushMissingTarget[]
    No documentation available
  • stats: OrbiterPushTargetStats
    No documentation available
  • targets: readonly OrbiterPushTarget[]
    No documentation available
T
OrbiterPushTargetStats = { readonly total: number; readonly shard: number; readonly root: number; readonly base: number; readonly skippedShards: number; readonly missing: number; }

Orbiter target-resolution counts split by base, root, and shard output.

  • base: number
    No documentation available
  • missing: number
    No documentation available
  • root: number
    No documentation available
  • shard: number
    No documentation available
  • skippedShards: number
    No documentation available
  • total: number
    No documentation available
T
ProviderAvailability =
{ readonly ok: true; }
| { readonly ok: false; readonly reason: "not-found" | "failed"; readonly hint?: string; readonly error?: unknown; }

Orbiter availability probe.

T
ProviderFmt = { readonly label: string; readonly value: string; }

Pre-formatted provider display row.

  • label: string
    No documentation available
  • value: string
    No documentation available
T
PushMissingTarget =
PushTargetContext
& { readonly reason: "missing-staging-output" | "missing-dist-metadata"; }

Push target that could not be resolved to publishable staging output.

T
PushPlanStats = { readonly total: number; readonly missing: number; }

Aggregate target-resolution counts for a provider push plan.

  • missing: number
    No documentation available
  • total: number
    No documentation available
T
PushProbe =
{ readonly ok: true; }
| { readonly ok: false; readonly reason:
"no-provider"
| "not-found"
| "failed"
| "unsupported-provider"
; readonly hint?: string; readonly error?: unknown; }

Provider preflight result before a deploy push is attempted.

T
PushPruneFile = { readonly path: t.Files.String.Path; readonly status: PushPruneFileStatus; }

Provider-reported stale-file removal outcome for one remote file path.

  • path: t.Files.String.Path
    No documentation available
  • status: PushPruneFileStatus
    No documentation available
T
PushPruneFileStatus = "removed"

Stable status for one provider prune file result.

T
PushPruneStats = { readonly files: readonly PushPruneFile[]; }

Rich provider prune details. Summary counts are derived, not stored.

  • files: readonly PushPruneFile[]
    No documentation available
T
PushPruneSummary = { readonly total: number; readonly removed: number; }

Derived stale-file removal counts for CLI reporting.

  • removed: number
    No documentation available
  • total: number
    No documentation available
T
PushPublishFile = { readonly path: t.Files.String.Path; readonly status: PushPublishFileStatus; readonly digest?: t.StringHash | t.StringUri; readonly bytes?: number; readonly mediaType?: t.StringMimeType; }

Provider-reported publish outcome for one staged file path.

  • bytes: number

    Bytes written during this push. Omitted for unchanged/skipped files.

  • digest: t.StringHash | t.StringUri

    Content digest/hash reference when known from staging metadata.

  • mediaType: t.StringMimeType
    No documentation available
  • path: t.Files.String.Path
    No documentation available
  • status: PushPublishFileStatus
    No documentation available
T
PushPublishFileStatus = "written" | "skipped"

Stable status for one provider publish file result.

T
PushPublishStats = { readonly files: readonly PushPublishFile[]; }

Rich provider publish details. Summary counts are derived, not stored.

  • files: readonly PushPublishFile[]
    No documentation available
T
PushPublishSummary = { readonly total: number; readonly written: number; readonly skipped: number; }

Derived publish counts for CLI reporting.

  • skipped: number
    No documentation available
  • total: number
    No documentation available
  • written: number
    No documentation available
T
PushResult =
{ readonly ok: true; readonly publish?: PushPublishStats; readonly prune?: PushPruneStats; }
| { readonly ok: false; readonly reason:
"probe-failed"
| "unsupported-provider"
| "not-implemented"
| "failed"
; readonly hint?: string; readonly error?: unknown; }

Push execution result.

T
PushTarget = OrbiterPushTarget | NoopPushTarget | R2PushTarget

Any provider-specific publish target the deploy push command can execute.

T
PushTargetContext = { readonly index?: number; readonly provider: string; readonly sourceDir?: t.StringDir; readonly stagingDir?: t.StringDir; readonly shard?: number; readonly domain?: string; readonly siteId?: string; readonly bucket?: string; readonly prefix?: string; }

Common identity and filesystem context for a resolved push target.

  • bucket: string
    No documentation available
  • domain: string
    No documentation available
  • index: number
    No documentation available
  • prefix: string
    No documentation available
  • provider: string
    No documentation available
  • shard: number
    No documentation available
  • siteId: string
    No documentation available
  • sourceDir: t.StringDir
    No documentation available
  • stagingDir: t.StringDir
    No documentation available
T
PushTargetPlan = { readonly targets: readonly PushTarget[]; readonly missing: readonly PushMissingTarget[]; readonly stats: PushPlanStats; }

Provider-neutral plan of publishable and missing push targets.

  • missing: readonly PushMissingTarget[]
    No documentation available
  • stats: PushPlanStats
    No documentation available
  • targets: readonly PushTarget[]
    No documentation available
T
R2Provider = { kind: "r2"; accountId: string; bucket: string; prefix: string; readOrigin?: t.StringUrl; credentials: { readonly accessKeyId: string; readonly secretAccessKey: string; readonly sessionToken?: string; }; }

R2 provider configuration (YAML configuration).

  • accountId: string

    Cloudflare account id that owns the R2 bucket.

  • bucket: string

    R2 bucket name.

  • credentials: { readonly accessKeyId: string; readonly secretAccessKey: string; readonly sessionToken?: string; }

    R2 HTTP access credentials.

  • kind: "r2"
    No documentation available
  • prefix: string

    Required object namespace prefix for this deploy target.

  • readOrigin: t.StringUrl

    Optional public read origin used by remote dist.json checks/content refs.

T
R2PushTarget = { readonly provider: t.DeployTool.Config.Provider.R2; readonly sourceDir: t.StringDir; readonly stagingDir: t.StringDir; readonly shard?: number; readonly domain?: string; }

Cloudflare R2 push target resolved from endpoint staging configuration.

  • domain: string
    No documentation available
  • provider: t.DeployTool.Config.Provider.R2
    No documentation available
  • shard: number
    No documentation available
  • sourceDir: t.StringDir
    No documentation available
  • stagingDir: t.StringDir
    No documentation available

Variables

v
Deploy: t.DeployTool.Lib

Public Deploy helper API.

v
DeployTool.ID: "deploy"
No documentation available
v
DeployTool.NAME: "system/deploy:tools"
No documentation available
pi

Functions

f
cli(
cwd,
argv
)

CLI pass-through for the published Pi launcher surface.

pull

Functions

f
cli(
cwd,
argv
): Promise<void>

Run Pull with interactive menus or explicit non-interactive arguments.

Namespaces

N
PullTool

Contracts for configured remote materialization and mutable local projections.

N
PullTool.Bundle

Execution contracts for one configured remote bundle.

N
PullTool.Bundle.Dist

Result truth for one checksum-pinned Dist bundle.

N
PullTool.Bundle.Dist.Projection

Mutable-copy settlement without generation authority or verification evidence.

N
PullTool.ConfigYaml

Strict durable configuration for Dist materialization and generic GitHub pulls.

Type Aliases

T
PullTool.Bundle.Dist.Failure = MaterializationFailure | ProjectionFailure

Failure in generation materialization or later mutable projection.

T
PullTool.Bundle.Dist.MaterializationFailure = { readonly ok: false; readonly kind: "materialization-failed"; readonly generation: t.Dist.Failed; readonly projection: Projection.NotRun; }

Server-owned materialization failed, so projection never acquired authority to run.

  • generation: t.Dist.Failed
    No documentation available
  • kind: "materialization-failed"
    No documentation available
  • ok: false
    No documentation available
  • projection: Projection.NotRun
    No documentation available
T
PullTool.Bundle.Dist.Projection.Failure = { readonly kind: "failed"; readonly reason:
"invalid-target"
| "target-occupied"
| "filesystem-failure"
| "rewrite-failure"
| "cancelled"
; readonly dir: t.StringAbsoluteDir; readonly mode: t.GithubPull.Mode; readonly error: string; }

Projection failed after the pinned generation outcome had settled.

  • dir: t.StringAbsoluteDir
    No documentation available
  • error: string
    No documentation available
  • kind: "failed"
    No documentation available
  • mode: t.GithubPull.Mode
    No documentation available
  • reason:
    "invalid-target"
    | "target-occupied"
    | "filesystem-failure"
    | "rewrite-failure"
    | "cancelled"
    No documentation available
T
PullTool.Bundle.Dist.Projection.NotRequested = { readonly kind: "not-requested"; }

Projection was absent from configuration.

  • kind: "not-requested"
    No documentation available
T
PullTool.Bundle.Dist.Projection.NotRun = { readonly kind: "not-run"; }

Projection could not run because materialization failed.

  • kind: "not-run"
    No documentation available
T
PullTool.Bundle.Dist.Projection.Success = { readonly kind: "projected"; readonly dir: t.StringAbsoluteDir; readonly mode: t.GithubPull.Mode; }

Mutable local projection completed without inheriting a verification claim.

  • dir: t.StringAbsoluteDir
    No documentation available
  • kind: "projected"
    No documentation available
  • mode: t.GithubPull.Mode
    No documentation available
T
PullTool.Bundle.Dist.ProjectionFailure = { readonly ok: false; readonly kind: "projection-failed"; readonly generation: t.Dist.Existing | t.Dist.Promoted; readonly projection: Projection.Failure; }

Pinned generation succeeded, but its separate mutable projection failed.

  • generation: t.Dist.Existing | t.Dist.Promoted
    No documentation available
  • kind: "projection-failed"
    No documentation available
  • ok: false
    No documentation available
  • projection: Projection.Failure
    No documentation available
T
PullTool.Bundle.Dist.Result = Success | Failure

Complete materialization and projection settlement.

T
PullTool.Bundle.Dist.Success = { readonly ok: true; readonly kind: "dist"; readonly generation: t.Dist.Existing | t.Dist.Promoted; readonly projection: Projection.NotRequested | Projection.Success; }

Pinned generation success with either no projection or a completed projection.

  • generation: t.Dist.Existing | t.Dist.Promoted
    No documentation available
  • kind: "dist"
    No documentation available
  • ok: true
    No documentation available
  • projection: Projection.NotRequested | Projection.Success
    No documentation available
T
PullTool.Bundle.RunOptions = { readonly silent?: boolean; readonly until?: t.UntilInput; }

Lifecycle and terminal-output options for one bundle.

  • silent: boolean
    No documentation available
  • until: t.UntilInput
    No documentation available
T
PullTool.CliArgs =
t.Tools.CliArgs
& { config?: string; manifest?: string; integrity?: string; store?: string; project?: string; mode?: t.GithubPull.Mode; dry-run?: boolean; non-interactive?: boolean; }

Raw Pull command-line arguments.

T
PullTool.CliCommand = "add"

Supported Pull subcommand.

T
PullTool.CliParsedArgs =
t.ParsedArgs<CliArgs>
& { readonly command?: CliCommand; readonly interactive: boolean; }

Parsed Pull arguments with normalized interaction mode.

T
PullTool.ConfigYaml.Bundle = DistBundle | GithubReleaseBundle | GithubRepoBundle

One supported configured remote bundle.

T
PullTool.ConfigYaml.DirName = `-config/${string}.${Id}`

Canonical Pull configuration directory name.

T
PullTool.ConfigYaml.DistBundle = { kind: "dist"; manifest: t.StringUrl; integrity: t.StringHash; store: t.StringRelativeDir; project?: DistProject; }

Checksum-pinned Dist authority and optional mutable projection.

  • integrity: t.StringHash
    No documentation available
  • kind: "dist"
    No documentation available
  • manifest: t.StringUrl
    No documentation available
  • project: DistProject
    No documentation available
  • store: t.StringRelativeDir
    No documentation available
T
PullTool.ConfigYaml.DistProject = { dir: t.StringRelativeDir; mode: t.GithubPull.Mode; }

Optional mutable copy of a pinned Dist generation.

  • dir: t.StringRelativeDir
    No documentation available
  • mode: t.GithubPull.Mode
    No documentation available
T
PullTool.ConfigYaml.Doc = { dir: t.StringDir; bundles?: Bundle[]; }

Strict YAML document owned by Pull.

  • bundles: Bundle[]
    No documentation available
  • dir: t.StringDir
    No documentation available
T
PullTool.ConfigYaml.Ext = ".yaml"

Pull configuration filename extension.

T
PullTool.ConfigYaml.GithubBundleBase = { repo: string; local: GithubBundleLocal; limits: t.GithubPull.Limits; }

Authority shared by bounded generic GitHub bundles.

  • limits: t.GithubPull.Limits
    No documentation available
  • local: GithubBundleLocal
    No documentation available
  • repo: string
    No documentation available
T
PullTool.ConfigYaml.GithubBundleLocal = { dir: t.StringRelativeDir; mode: t.GithubPull.Mode; }

Explicit mutable target for a generic GitHub pull.

  • dir: t.StringRelativeDir
    No documentation available
  • mode: t.GithubPull.Mode
    No documentation available
T
PullTool.ConfigYaml.GithubReleaseBundle =
GithubBundleBase
& { kind: "github:release"; tag?: string; asset?: string | string[]; }

Bounded GitHub release-asset bundle.

T
PullTool.ConfigYaml.GithubRepoBundle =
GithubBundleBase
& { kind: "github:repo"; ref?: string; path?: string; }

Bounded GitHub repository-tree bundle.

T
PullTool.ConfigYaml.LoadResult =
{ readonly ok: true; readonly cwd: t.StringDir; readonly location: Location; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }

Pull configuration load result.

T
PullTool.ConfigYaml.Location = { readonly dir: t.StringDir; readonly bundles?: Bundle[]; }

Validated bundles with their resolved execution root.

  • bundles: Bundle[]
    No documentation available
  • dir: t.StringDir
    No documentation available
T
PullTool.ConfigYaml.Resolved = { readonly config: t.StringPath; readonly cwd: t.StringDir; readonly dir: t.StringDir; readonly localDirs: readonly ResolvedLocalDir[]; }

Resolved Pull configuration and its mutable output targets.

  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • dir: t.StringDir
    No documentation available
  • localDirs: readonly ResolvedLocalDir[]
    No documentation available
T
PullTool.ConfigYaml.ResolvedLocalDir = { readonly index: number; readonly dir: t.StringRelativeDir; readonly path: t.StringDir; readonly bundle: Bundle; }

Resolved mutable output target for a pull bundle.

  • bundle: Bundle
    No documentation available
  • dir: t.StringRelativeDir
    No documentation available
  • index: number
    No documentation available
  • path: t.StringDir
    No documentation available
T
PullTool.ConfigYaml.YamlCheck =
{ readonly ok: true; readonly doc: Doc; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }

Strict YAML validation result.

T
PullTool.Id = "pull"

Pull registry identifier literal.

T
PullTool.Lib = { resolve(config: t.StringPath): Promise<ConfigYaml.Resolved>; run(args: RunArgs): Promise<RunResult>; }

Public API for resolving and executing durable Pull configuration.

  • resolve(config: t.StringPath): Promise<ConfigYaml.Resolved>

    Resolve configured mutable outputs without network or filesystem mutation.

  • run(args: RunArgs): Promise<RunResult>

    Materialize every bundle in one owner config, throwing at the first failed bundle.

T
PullTool.MenuCmd =
"config"
| "config:edit"
| "config:rename"
| "bundle:add-dist"
| "back"
| "exit"

Command names.

T
PullTool.MenuOption = { readonly name: string; readonly value: MenuCmd; }

One interactive Pull menu option.

  • name: string
    No documentation available
  • value: MenuCmd
    No documentation available
T
PullTool.Name = "system/pull:tools"

Pull tool-name literal.

T
PullTool.RunArgs =
{ readonly cwd?: t.StringDir; readonly until?: t.UntilInput; }
& t.Tools.ConfigRefArgs

Arguments for a programmatic Pull run.

T
PullTool.RunBundleResult =
{ readonly bundle: ConfigYaml.DistBundle; readonly data: Bundle.Dist.Success; }
| { readonly bundle: ConfigYaml.GithubReleaseBundle | ConfigYaml.GithubRepoBundle; readonly data: t.GithubPull.Success; }

Successful result retained for one configured bundle; run throws on any bundle failure.

T
PullTool.RunResult = { readonly ok: true; readonly config: t.StringPath; readonly cwd: t.StringDir; readonly dir: t.StringDir; readonly bundles: readonly RunBundleResult[]; }

Successful settlement of every bundle in one programmatic Pull run.

  • bundles: readonly RunBundleResult[]
    No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • dir: t.StringDir
    No documentation available
  • ok: true
    No documentation available
T
PullToolsLib = { cli(
cwd?: t.StringDir,
argv?: string[]
): Promise<void>; }

Pull CLI entry contract.

  • cli(
    cwd?: t.StringDir,
    argv?: string[]
    ): Promise<void>

    Run Pull with interactive menus or explicit non-interactive arguments.

Variables

v
GithubPull: t.GithubPull.Lib

Bounded generic GitHub release and repository downloads.

v
Pull: t.PullTool.Lib

Resolve and execute durable Pull configuration.

serve

Functions

f
cli(
cwd,
argv
)

Main entry:

Namespaces

N
ServeTool

The @sys/tools/serve type namespace.

N
ServeTool.JsonView

JSON view outcome for a requestable path.

N
ServeTool.LocationYaml

YAML-authored serve location configuration (authoritative).

Type Aliases

T
ServeTool.CliArgs =
t.Tools.CliArgs
& { port?: number; dir?: string; config?: string; profile?: string; host?: Host; open?: boolean; non-interactive?: boolean; }

Command line arguments (argv).

T
ServeTool.CliParsedArgs = t.ParsedArgs<CliArgs> & { interactive: boolean; }
No documentation available
T
ServeTool.Command =
"dir:add"
| "dir:remove"
| "serve:start/local"
| "serve:start/network"
| "open"
| "reload"
| "back"
| "exit"

Command names.

T
ServeTool.Host = "local" | "network"

Programmatic server host policy.

T
ServeTool.Hostname = "127.0.0.1" | "0.0.0.0"

Concrete bind hostname derived from the host policy.

T
ServeTool.Id = ID
No documentation available
T
ServeTool.JsonView.File = { readonly kind: "file"; readonly body: { mime: t.StringMimeType; path: t.StringPath; hash: t.StringHash; bytes: t.NumberBytes; }; }
No documentation available
  • body: { mime: t.StringMimeType; path: t.StringPath; hash: t.StringHash; bytes: t.NumberBytes; }
    No documentation available
  • kind: "file"
    No documentation available
T
ServeTool.JsonView.Folder = { readonly kind: "folder"; readonly body: { dir: t.StringName; files: t.StringName[]; about: { pkg: t.Pkg; cmd: "serve"; }; }; }
No documentation available
  • body: { dir: t.StringName; files: t.StringName[]; about: { pkg: t.Pkg; cmd: "serve"; }; }
    No documentation available
  • kind: "folder"
    No documentation available
T
ServeTool.JsonView.Result = File | Folder
No documentation available
T
ServeTool.Lib = { start(args: StartArgs): Promise<StartResult>; }

Public serve helper API.

  • start(args: StartArgs): Promise<StartResult>

    Start a static serve target from a directory, config path, or named profile.

T
ServeTool.LocationYaml.DirName = `-config/${string}.serve`

Filesystem conventions for serve location YAML storage.

T
ServeTool.LocationYaml.Doc = { name: string; dir: t.StringDir; info?: Record<string, string>; }

YAML document structure for a serve location.

  • dir: t.StringDir

    Directory to serve (relative to CLI cwd, or absolute).

  • info: Record<string, string>

    Extra human-facing server info; path-like values decorate the served URL.

  • name: string

    Display name.

T
ServeTool.LocationYaml.Ext = ".yaml"
No documentation available
T
ServeTool.LocationYaml.LoadResult =
{ readonly ok: true; readonly cwd: t.StringDir; readonly location: Location; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }
No documentation available
T
ServeTool.LocationYaml.Location = { readonly name: string; readonly dir: t.StringDir; readonly info?: Record<string, string>; }

Runtime location with resolved paths.

  • dir: t.StringDir

    Resolved absolute directory to serve.

  • info: Record<string, string>

    Extra human-facing server info; path-like values decorate the served URL.

  • name: string

    Display name.

T
ServeTool.LocationYaml.YamlCheck =
{ readonly ok: true; readonly doc: Doc; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }
No documentation available
T
ServeTool.MenuOption = { name: string; value: Command; }
No documentation available
  • name: string
    No documentation available
  • value: Command
    No documentation available
T
ServeTool.Name = NAME
No documentation available
T
ServeTool.RouteView = "json"

Alternative view formats for rendering a route.

T
ServeTool.StartArgs = StartArgsBase & StartSelectorArgs
No documentation available
T
ServeTool.StartArgsBase = { cwd?: t.StringDir; host?: Host; port?: number; until?: t.UntilInput; }
No documentation available
  • cwd: t.StringDir
    No documentation available
  • host: Host
    No documentation available
  • port: number

    Use 0 to let the runtime choose an available port.

  • until: t.UntilInput

    Canonical @sys lifecycle bridge.

T
ServeTool.StartConfigArgs = { config: t.StringPath; paths?: StartConfigPathsInput; dir?: never; profile?: never; }
No documentation available
  • config: t.StringPath

    Explicit serve YAML config path.

  • dir: never
    No documentation available
  • paths: StartConfigPathsInput

    Equivalent owner config ref; accepted only when it resolves to the same path.

  • profile: never
    No documentation available
T
ServeTool.StartConfigPaths = { config: t.StringPath; }

Owner config refs supplied by programmatic lifecycle callers.

  • config: t.StringPath
    No documentation available
T
ServeTool.StartConfigPathsInput = { config?: t.StringPath; }

Optional owner config refs for selector alias compatibility.

  • config: t.StringPath
    No documentation available
T
ServeTool.StartDirArgs = { dir: t.StringDir; config?: never; profile?: never; paths?: never; }
No documentation available
  • config: never
    No documentation available
  • dir: t.StringDir

    Serve this directory directly, resolved relative to cwd.

  • paths: never
    No documentation available
  • profile: never
    No documentation available
T
ServeTool.StartPathsConfigArgs = { paths: StartConfigPaths; dir?: never; config?: never; profile?: never; }
No documentation available
  • config: never
    No documentation available
  • dir: never
    No documentation available
  • paths: StartConfigPaths

    Owner config refs supplied by programmatic lifecycle callers.

  • profile: never
    No documentation available
T
ServeTool.StartProfileArgs = { profile: string; dir?: never; config?: never; paths?: never; }
No documentation available
  • config: never
    No documentation available
  • dir: never
    No documentation available
  • paths: never
    No documentation available
  • profile: string

    Bare serve config profile name under -config/@sys.tools.serve.

T
ServeTool.StartResult = { readonly ok: true; readonly cwd: t.StringDir; readonly selector: StartTargetSelector; readonly config?: t.StringPath; readonly location: LocationYaml.Location; readonly host: Host; readonly hostname: Hostname; readonly port: number; readonly baseUrl: t.StringUrl; readonly url: t.StringUrl; readonly finished: Promise<void>; readonly close: (reason?: unknown) => Promise<void>; status(): t.Service.Status; }
No documentation available
  • baseUrl: t.StringUrl
    No documentation available
  • close: (reason?: unknown) => Promise<void>
    No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • finished: Promise<void>
    No documentation available
  • host: Host
    No documentation available
  • hostname: Hostname
    No documentation available
  • location: LocationYaml.Location
    No documentation available
  • ok: true
    No documentation available
  • port: number
    No documentation available
  • selector: StartTargetSelector
    No documentation available
  • status(): t.Service.Status

    Renderer-neutral service status snapshot.

  • url: t.StringUrl
    No documentation available
T
ServeTool.StartSelectorArgs =
StartDirArgs
| StartConfigArgs
| StartPathsConfigArgs
| StartProfileArgs
No documentation available
T
ServeTool.StartServerOpts = { readonly port?: number; readonly host?: Host; readonly silent?: boolean; readonly keyboard?: boolean; readonly until?: t.UntilInput; }

Low-level static server start options.

  • host: Host
    No documentation available
  • keyboard: boolean
    No documentation available
  • port: number
    No documentation available
  • silent: boolean
    No documentation available
  • until: t.UntilInput
    No documentation available
T
ServeTool.StartServingContext = { readonly location: LocationYaml.Location; readonly host: Host; readonly hostname: Hostname; readonly port: number; readonly baseUrl: t.StringUrl; readonly url: t.StringUrl; readonly server: Deno.HttpServer<Deno.NetAddr>; readonly close: (reason?: unknown) => Promise<void>; }

Running low-level static server context.

  • baseUrl: t.StringUrl
    No documentation available
  • close: (reason?: unknown) => Promise<void>
    No documentation available
  • host: Host
    No documentation available
  • hostname: Hostname
    No documentation available
  • location: LocationYaml.Location
    No documentation available
  • port: number
    No documentation available
  • server: Deno.HttpServer<Deno.NetAddr>
    No documentation available
  • url: t.StringUrl
    No documentation available
T
ServeTool.StartTarget = { readonly cwd: t.StringDir; readonly selector: StartTargetSelector; readonly config?: t.StringPath; readonly location: LocationYaml.Location; }
No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • location: LocationYaml.Location
    No documentation available
  • selector: StartTargetSelector
    No documentation available
T
ServeTool.StartTargetInput = { dir?: string; config?: string; profile?: string; paths?: StartTargetPathsInput; }
No documentation available
  • config: string
    No documentation available
  • dir: string
    No documentation available
  • paths: StartTargetPathsInput
    No documentation available
  • profile: string
    No documentation available
T
ServeTool.StartTargetPathsInput = { config?: string; }

Permissive raw target input used before selector normalization.

  • config: string
    No documentation available
T
ServeTool.StartTargetSelector =
{ readonly kind: "dir"; readonly input: string; readonly dir: t.StringDir; }
| { readonly kind: "config"; readonly config: t.StringPath; }
| { readonly kind: "profile"; readonly profile: string; readonly config: t.StringPath; }
No documentation available
T
ServeToolsLib = { cli(
cwd?: t.StringDir,
argv?: string[]
): Promise<void>; }

CLI helpers for working with Serve.

  • cli(
    cwd?: t.StringDir,
    argv?: string[]
    ): Promise<void>

    Run the serve CLI flow (interactive by default, strict with --non-interactive).

Variables

v
Serve: t.ServeTool.Lib

Public Serve helper API.

v
ServeTool.ID: "serve"
No documentation available
v
ServeTool.NAME: "system/serve:tools"
No documentation available
shell

Functions

f
cli(
_cwd,
argv,
context,
deps?: CliDeps
)
No documentation available

Variables

v
ShellTools: t.ShellTool.Lib
No documentation available
tmpl

Functions

f
cli(
cwd,
argv
)

CLI pass-through for the published template launcher surface.

upgrade

Functions

f
cli(
cwd,
argv,
context
)
No documentation available

Variables

v
UpgradeTools: t.UpgradeToolsLib

Upgrade tools.

upgrade/advisory-probe

Functions

f
runUpgradeAdvisoryProbe(deps?: { readonly getVersionInfo?: GetVersionInfo; readonly writeSuccess?: WriteSuccess; readonly writeFailure?: WriteFailure; }): Promise<
{ readonly ok: true; readonly remote: t.StringSemver; }
| { readonly ok: false; }
>

Probe the published @sys/tools version and persist the advisory result.

Type Aliases

video

Functions

f
cli(
cwd,
argv
)
No documentation available

Variables

v
VideoTools: t.VideoToolsLib

VideoTools Programmatic utilities for video conversion. Designed for direct use in code or automated pipelines (no CLI prompts).

types

Namespaces

N
ClipboardTool

The @sys/tools/copy (clipboard) namepsace.

N
CrdtTool

The @sys/tools/crdt type namespace.

N
CrdtTool.Doc

Document related types.

N
CrdtTool.Doc.Graph

Document-graph types.

N
CrdtTool.DocumentYaml

YAML-authored document configuration (authoritative).

N
CrdtTool.Hook

Root-level hook types.

N
CrdtTool.RepoYaml

YAML-authored repo configuration (authoritative).

N
CryptoTool

The Crypto type namespace.

N
CryptoTool.ConfigYaml
No documentation available
N
DeployTool

Tools for deploying files to a publishing endpoint (CDN).

N
DeployTool.Config
No documentation available
N
DeployTool.Config.EndpointYaml

YAML-authored endpoint configuration (authoritative). (We keep these types here so callers can share the same vocabulary.)

N
DeployTool.Config.Provider

Deployment provider configuration.

N
DeployTool.Endpoint
No documentation available
N
DeployTool.Endpoint.Fs

Filesystem conventions for endpoint YAML storage.

N
DeployTool.Endpoint.Menu
No documentation available
N
DeployTool.PushOperation
No documentation available
N
DeployTool.StageOperation
No documentation available
N
DeployTool.Staging
No documentation available
N
GithubPull

Bounded, confined GitHub download authority.

N
Help

Package help resource types.

N
Help.Dsl

Tools DSL guidance resources.

N
Help.Root

Root help resources.

N
PiTool

The @sys/tools/pi namespace.

N
PullTool

Contracts for configured remote materialization and mutable local projections.

N
PullTool.Bundle

Execution contracts for one configured remote bundle.

N
PullTool.Bundle.Dist

Result truth for one checksum-pinned Dist bundle.

N
PullTool.Bundle.Dist.Projection

Mutable-copy settlement without generation authority or verification evidence.

N
PullTool.ConfigYaml

Strict durable configuration for Dist materialization and generic GitHub pulls.

N
ServeTool

The @sys/tools/serve type namespace.

N
ServeTool.JsonView

JSON view outcome for a requestable path.

N
ServeTool.LocationYaml

YAML-authored serve location configuration (authoritative).

N
ShellTool

The @sys/tools/shell namespace.

N
ShellTool.Alias

Alias command state and plans.

N
ShellTool.Apply

Recommended baseline shell init flow.

N
ShellTool.Doctor

Read-only shell doctor report.

N
ShellTool.Path

PATH command state and plans.

N
TmplTool

The Tmpl tool namespace.

N
Tools

Root @sys/tools type namespace.

N
Tools.Prompt

Common UI prompts:

N
Tools.Prompt.Dirs
No documentation available
N
UpgradeTool

The @sys/tools/upgrade namespace.

N
VideoTool

The @sys/tools/video type namespace.

Type Aliases

T
ClipboardTool.CliArgs = t.Tools.CliArgs

Command line arguments (argv).

T
ClipboardTool.CliParsedArgs = t.ParsedArgs<CliArgs>
No documentation available
T
ClipboardTool.Command =
"types:select"
| "types:all"
| "files:select"
| "files:all"
| "files:deno.json"
| "git:changed"

Command names.

T
ClipboardTool.Id = ID
No documentation available
T
ClipboardTool.MenuOption = { name: string; value: Command; }
No documentation available
  • name: string
    No documentation available
  • value: Command
    No documentation available
T
ClipboardTool.Name = NAME
No documentation available
T
CrdtTool.CliArgs = t.Tools.CliArgs

Command line arguments (argv).

T
CrdtTool.CliParsedArgs = t.ParsedArgs<CliArgs>
No documentation available
T
CrdtTool.Command =
"snapshot"
| "doc:add"
| "doc:remove"
| "doc:rename"
| "doc:graph:walk"
| "doc:graph:dag"
| "doc:viewer:yaml"
| "doc:tmpl:hookfile"
| "root:tmpl:hookfile"
| "repo:daemon:start"
| "repo:syncserver:start"
| "back"
| "exit"
| "tmp:🐷"

Command names.

T
CrdtTool.Doc.Graph.DagHook = t.DocumentGraphDagHook
No documentation available
T
CrdtTool.Doc.Graph.Plugin = t.DocumentGraphPlugin
No documentation available
T
CrdtTool.Doc.Graph.WalkHook = t.DocumentGraphWalkHook
No documentation available
T
CrdtTool.DocumentYaml.DirName = `-config/${string}.crdt/docs`

Filesystem conventions for document YAML storage.

T
CrdtTool.DocumentYaml.Doc = { id: t.StringId; name?: t.StringName; }

YAML document structure for a tracked CRDT document.

  • id: t.StringId

    Document identifier.

  • name: t.StringName

    Optional display name.

T
CrdtTool.DocumentYaml.Ext = ".yaml"
No documentation available
T
CrdtTool.DocumentYaml.YamlCheck =
{ readonly ok: true; readonly doc: Doc; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }
No documentation available
T
CrdtTool.Hook.Module = t.RootHookModule
No documentation available
T
CrdtTool.Hook.Plugin = t.RootHookPlugin
No documentation available
T
CrdtTool.Hook.PluginResult = t.RootHookPluginResult
No documentation available
T
CrdtTool.Hook.PluginResultKind = t.RootHookPluginResultKind
No documentation available
T
CrdtTool.Id = ID
No documentation available
T
CrdtTool.Name = NAME
No documentation available
T
CrdtTool.RepoYaml.DirName = `-config/${string}.crdt`

Filesystem conventions for repo YAML storage.

T
CrdtTool.RepoYaml.Doc = { sync: SyncItem[]; ports?: { repo?: number; sync?: number; }; }

YAML document structure for repo configuration.

  • ports: { repo?: number; sync?: number; }

    Port configuration.

  • sync: SyncItem[]

    Sync websocket endpoints.

T
CrdtTool.RepoYaml.Ext = ".yaml"
No documentation available
T
CrdtTool.RepoYaml.SyncItem = { endpoint: string; enabled?: boolean; }

Sync endpoint entry.

  • enabled: boolean
    No documentation available
  • endpoint: string
    No documentation available
T
CrdtTool.RepoYaml.YamlCheck =
{ readonly ok: true; readonly doc: Doc; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }
No documentation available
T
CryptoTool.CliArgs = t.Tools.CliArgs

Command line arguments (argv).

T
CryptoTool.CliParsedArgs =
t.ParsedArgs<CliArgs>
& { readonly command?: SubCmd; readonly save?: boolean; }
No documentation available
T
CryptoTool.ConfigYaml.DirName = `-config/${string}.${Id}`
No documentation available
T
CryptoTool.ConfigYaml.Doc = { name: string; }
No documentation available
  • name: string
    No documentation available
T
CryptoTool.ConfigYaml.Ext = ".yaml"
No documentation available
T
CryptoTool.ConfigYaml.YamlCheck =
{ readonly ok: true; readonly doc: Doc; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }
No documentation available
T
CryptoTool.Id = ID
No documentation available
T
CryptoTool.MenuCmd = "init" | "help" | "hash:cwd" | "config" | "back" | "exit"

Command names.

T
CryptoTool.MenuOption = { readonly name: string; readonly value: MenuCmd; }
No documentation available
  • name: string
    No documentation available
  • value: MenuCmd
    No documentation available
T
CryptoTool.Name = NAME
No documentation available
T
CryptoTool.SubCmd = "hash"

CLI sub-commands (first positional token).

T
DeployTool.CliAction = "stage" | "push" | "stage+push"

Command line arguments (argv).

T
DeployTool.CliArgs =
t.Tools.CliArgs
& { config?: string; action?: CliAction; non-interactive?: boolean; force?: boolean; }
No documentation available
T
DeployTool.CliParsedArgs = t.ParsedArgs<CliArgs> & { interactive: boolean; }
No documentation available
T
DeployTool.Command = "back" | "exit"

Command names.

T
DeployTool.Config.Doc =
t.JsonFile.Doc
& { name: string; endpoints?: readonly EndpointRef[]; }
No documentation available
T
DeployTool.Config.EndpointRef = t.Tools.Recency & { name: string; file: t.StringPath; }

An endpoint reference tracked in config.json for recency + lookup. The endpoint's actual configuration is authored in YAML.

T
DeployTool.Config.EndpointYaml.Doc = { provider?: Provider.All; source?: Source; staging?: Staging; mappings?: readonly Mapping[]; }
No documentation available
  • mappings: readonly Mapping[]

    Directory mappings assembled into this endpoint.

  • provider: Provider.All

    Optional provider adapter config.

  • source: Source

    Source root for this endpoint.

  • staging: Staging

    Staging root for this endpoint.

T
DeployTool.Config.EndpointYaml.Mapping = { dir: { source: t.StringDir; staging: "." | t.StringPath; }; mode: SourceMode; shards?: { total: number; requireAll?: boolean; }; }

Maps an input directory into the generated endpoint staging dir. (Source may be absolute or relative; resolution rules are handled by runtime.)

  • dir: { source: t.StringDir; staging: "." | t.StringPath; }
    No documentation available
  • mode: SourceMode
    No documentation available
  • shards: { total: number; requireAll?: boolean; }

    Optional shard expansion for template paths. When provided and templates are present, mappings are expanded per shard.

T
DeployTool.Config.EndpointYaml.Source = { dir: t.StringPath; }

Endpoint source root. Mapping dir.source values are resolved relative to this directory.

  • dir: t.StringPath

    Root directory for sources (relative to deploy cwd).

T
DeployTool.Config.EndpointYaml.SourceMode = "copy" | "build+copy" | "index"

Canonical per-mapping behavior.

T
DeployTool.Config.EndpointYaml.Staging = { dir: t.StringPath; clear?: boolean; serve?: { port?: number; }; html?: { buildReset?: boolean; }; }

Endpoint staging root. All mapping dir.staging paths are resolved relative to this directory.

  • clear: boolean

    When true, clears staging targets before running mappings.

  • dir: t.StringPath

    Root directory for staging (relative to deploy cwd).

  • html: { buildReset?: boolean; }

    Optional HTML staging policies.

  • serve: { port?: number; }

    Optional local serve configuration for staged endpoint sanity checks.

T
DeployTool.Config.File = t.JsonFile.Instance<Doc>
No documentation available
T
DeployTool.Config.Provider.All = Orbiter | Noop | R2

Tagged union of all supported provider configs. Add new providers here (and in u.providers schemas) as they land.

T
DeployTool.Config.Provider.Noop = t.NoopProvider
No documentation available
T
DeployTool.Config.Provider.Orbiter = t.OrbiterProvider
No documentation available
T
DeployTool.Config.Provider.R2 = t.R2Provider
No documentation available
T
DeployTool.Endpoint.Fs.DirName = `-config/${string}.deploy`
No documentation available
T
DeployTool.Endpoint.Fs.Ext = ".yaml"
No documentation available
T
DeployTool.Endpoint.Fs.YamlCheck =
{ readonly ok: true; readonly doc: t.DeployTool.Config.EndpointYaml.Doc; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }
No documentation available
T
DeployTool.Endpoint.Menu.Action =
"stage"
| "push"
| "stage-push"
| "serve"
| "edit"
| "reload"
| "fix"
| "rename"
| "delete"
| "back"
No documentation available
T
DeployTool.Endpoint.Menu.Option = { readonly name: string; readonly value: Action; }
No documentation available
  • name: string
    No documentation available
  • value: Action
    No documentation available
T
DeployTool.Endpoint.RunAction = Extract<Menu.Action, "stage" | "push" | "stage-push" | "serve">
No documentation available
T
DeployTool.Endpoint.RunResult = { readonly ok: boolean; readonly stageOk?: boolean; readonly push?: { readonly ok: boolean; readonly elapsed?: string; readonly shards?: number; readonly bytes?: number; readonly publish?: t.PushPublishStats; readonly prune?: t.PushPruneStats; }; readonly error?: unknown; }
No documentation available
  • error: unknown
    No documentation available
  • ok: boolean
    No documentation available
  • push: { readonly ok: boolean; readonly elapsed?: string; readonly shards?: number; readonly bytes?: number; readonly publish?: t.PushPublishStats; readonly prune?: t.PushPruneStats; }
    No documentation available
  • stageOk: boolean
    No documentation available
T
DeployTool.Id = ID
No documentation available
T
DeployTool.Lib = { stage(args: StageArgs): Promise<StageResult>; push(args: PushArgs): Promise<PushResult>; }

Public deploy helper API.

  • push(args: PushArgs): Promise<PushResult>

    Push an already-staged endpoint from owner YAML.

  • stage(args: StageArgs): Promise<StageResult>

    Stage endpoint files from owner YAML.

T
DeployTool.MenuOption = { name: string; value: Command; }
No documentation available
  • name: string
    No documentation available
  • value: Command
    No documentation available
T
DeployTool.Name = NAME
No documentation available
T
DeployTool.PushArgs =
{ readonly cwd?: t.StringDir; readonly force?: boolean; }
& t.Tools.ConfigRefArgs
No documentation available
T
DeployTool.PushOperation.Failure = { readonly ok: false; readonly cwd: t.StringDir; readonly config: t.StringPath; readonly reason:
"yaml-invalid"
| "no-provider"
| "no-push-targets"
| "no-staging-output"
| "probe-failed"
| "unsupported-provider"
| "not-implemented"
| "failed"
; readonly hint?: string; readonly target?: t.PushTargetContext; readonly missing?: readonly t.PushMissingTarget[]; readonly error?: unknown; }
No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • error: unknown
    No documentation available
  • hint: string
    No documentation available
  • missing: readonly t.PushMissingTarget[]
    No documentation available
  • ok: false
    No documentation available
  • reason:
    "yaml-invalid"
    | "no-provider"
    | "no-push-targets"
    | "no-staging-output"
    | "probe-failed"
    | "unsupported-provider"
    | "not-implemented"
    | "failed"
    No documentation available
  • target: t.PushTargetContext
    No documentation available
T
DeployTool.PushOperation.Result = PushResult | Failure
No documentation available
T
DeployTool.PushResult = { readonly ok: true; readonly cwd: t.StringDir; readonly config: t.StringPath; readonly targets: number; readonly elapsed?: string; readonly shards?: number; readonly bytes?: number; readonly publish?: t.PushPublishStats; readonly prune?: t.PushPruneStats; }
No documentation available
  • bytes: number
    No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • elapsed: string
    No documentation available
  • ok: true
    No documentation available
  • prune: t.PushPruneStats

    Provider-reported stale-file removals when available.

  • publish: t.PushPublishStats

    Provider-reported per-file publish details when available.

  • shards: number
    No documentation available
  • targets: number
    No documentation available
T
DeployTool.StageArgs = { readonly cwd?: t.StringDir; } & t.Tools.ConfigRefArgs
No documentation available
T
DeployTool.StageOperation.Failure = { readonly ok: false; readonly config: t.StringPath; readonly cwd: t.StringDir; readonly stagingRoot?: t.StringDir; readonly error?: unknown; }
No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • error: unknown
    No documentation available
  • ok: false
    No documentation available
  • stagingRoot: t.StringDir
    No documentation available
T
DeployTool.StageOperation.Result = StageResult | Failure
No documentation available
T
DeployTool.StageResult = { readonly ok: true; readonly config: t.StringPath; readonly cwd: t.StringDir; readonly stagingRoot: t.StringDir; }
No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • ok: true
    No documentation available
  • stagingRoot: t.StringDir
    No documentation available
T
DeployTool.Staging.Dir = { readonly source: t.StringDir; readonly staging: t.StringRelativeDir; }

Source → staging directory mapping.

  • source: t.StringDir
    No documentation available
  • staging: t.StringRelativeDir
    No documentation available
T
DeployTool.Staging.Mapping =
{ readonly mode: "copy"; readonly dir: Dir; }
| { readonly mode: "build+copy"; readonly dir: Dir; }
| { readonly mode: "index"; readonly dir: Dir; }

Staging operation.

T
DeployTool.Staging.ProgressEvent = { readonly kind: ProgressKind; readonly index: number; readonly total: number; readonly mode: t.DeployTool.Staging.Mapping["mode"]; readonly source: t.StringPath; readonly staging: t.StringPath; readonly label?: string; readonly error?: unknown; }
No documentation available
  • error: unknown
    No documentation available
  • index: number
    No documentation available
  • kind: ProgressKind
    No documentation available
  • label: string
    No documentation available
  • mode: t.DeployTool.Staging.Mapping["mode"]
    No documentation available
  • source: t.StringPath
    No documentation available
  • staging: t.StringPath
    No documentation available
  • total: number
    No documentation available
T
DeployTool.Staging.ProgressKind =
"mapping:start"
| "mapping:step"
| "mapping:done"
| "mapping:fail"

Build progress.

T
DeployTool.Staging.ProgressReport<K extends ProgressKind> = { readonly kind: K; readonly label: string; }
No documentation available
  • kind: K
    No documentation available
  • label: string
    No documentation available
T
GithubPull.Args = { readonly repo: string; readonly into: t.StringDir; readonly mode: Mode; readonly limits: Limits; readonly token?: string; readonly until?: t.UntilInput; }

Inputs shared by release and repository operations.

  • into: t.StringDir

    Exact output directory selected by the caller.

  • limits: Limits

    Required finite operation limits.

  • mode: Mode

    Whether the output must be absent or may be explicitly replaced.

  • repo: string

    GitHub repository in exact owner/repo form.

  • token: string

    Optional GitHub token sent only to the admitted GitHub API origin.

  • until: t.UntilInput

    Cancel when this lifecycle ends.

T
GithubPull.DownloadedFile = { readonly source: t.StringUrl; readonly target: t.StringRelativePath; readonly bytes: t.NumberBytes; }

One successfully published generic file.

  • bytes: t.NumberBytes

    Exact bytes published.

  • source: t.StringUrl

    Owner-constructed GitHub source URL requested for this file.

  • target: t.StringRelativePath

    Root-relative target beneath into.

T
GithubPull.Failure = { readonly ok: false; readonly kind: FailureKind; readonly error: string; readonly into?: t.StringAbsoluteDir; readonly resolved?: Resolved; readonly files: readonly DownloadedFile[]; }

Failed operation with truthful partial-publication records.

  • error: string
    No documentation available
  • files: readonly DownloadedFile[]
    No documentation available
  • into: t.StringAbsoluteDir
    No documentation available
  • kind: FailureKind
    No documentation available
  • ok: false
    No documentation available
  • resolved: Resolved
    No documentation available
T
GithubPull.FailureKind =
"invalid-input"
| "source-failure"
| "limit-exceeded"
| "target-occupied"
| "unsafe-target"
| "publication-failure"
| "cancelled"

Stable public failure classification.

T
GithubPull.Lib = { readonly release: (args: ReleaseArgs) => Promise<Outcome>; readonly repo: (args: RepoArgs) => Promise<Outcome>; }

Public GitHub Pull operations.

  • release: (args: ReleaseArgs) => Promise<Outcome>

    Download selected release assets into one explicit target directory.

  • repo: (args: RepoArgs) => Promise<Outcome>

    Download a repository tree or subtree into one explicit target directory.

T
GithubPull.Limits = { readonly metadataBytes: t.NumberBytes; readonly entries: t.NumberTotal; readonly fileBytes: t.NumberBytes; readonly totalBytes: t.NumberBytes; readonly totalTime: t.Msecs; }

Required finite limits for one complete operation.

  • entries: t.NumberTotal

    Maximum source entries admitted before download.

  • fileBytes: t.NumberBytes

    Maximum bytes accepted for any one downloaded file.

  • metadataBytes: t.NumberBytes

    Maximum aggregate bytes retained across source metadata responses.

  • totalBytes: t.NumberBytes

    Maximum aggregate downloaded file bytes.

  • totalTime: t.Msecs

    Maximum milliseconds for the complete operation.

T
GithubPull.Mode = "create" | "replace"

Explicit target mutation authority.

T
GithubPull.Outcome = Success | Failure

Complete public operation result.

T
GithubPull.ReleaseArgs =
Args
& { readonly tag?: string; readonly assets?: readonly string[]; }

Release download inputs.

T
GithubPull.ReleaseResolved = { readonly kind: "github:release"; readonly repo: string; readonly tag: string; readonly assets: readonly string[]; }

Resolved release evidence.

  • assets: readonly string[]
    No documentation available
  • kind: "github:release"
    No documentation available
  • repo: string
    No documentation available
  • tag: string
    No documentation available
T
GithubPull.RepoArgs = Args & { readonly ref?: string; readonly path?: string; }

Repository download inputs.

T
GithubPull.RepoResolved = { readonly kind: "github:repo"; readonly repo: string; readonly ref: string; readonly commit: string; readonly tree: string; readonly path?: string; }

Resolved repository evidence.

  • commit: string
    No documentation available
  • kind: "github:repo"
    No documentation available
  • path: string
    No documentation available
  • ref: string
    No documentation available
  • repo: string
    No documentation available
  • tree: string
    No documentation available
T
GithubPull.Resolved = ReleaseResolved | RepoResolved

Resolved source evidence.

T
GithubPull.Success = { readonly ok: true; readonly into: t.StringAbsoluteDir; readonly resolved: Resolved; readonly files: readonly DownloadedFile[]; }

Successful generic download.

  • files: readonly DownloadedFile[]
    No documentation available
  • into: t.StringAbsoluteDir
    No documentation available
  • ok: true
    No documentation available
  • resolved: Resolved
    No documentation available
T
Help.Dsl.Chapter = t.Cli.Fmt.Chapters.Chapter

Navigable DSL chapter used by CLI composition.

T
Help.Dsl.ChapterResource = t.Cli.Fmt.Chapters.Chapter.Resource<t.StringPath>

Authored DSL chapter resource registered for recursive lookup.

T
Help.Dsl.Lib = { load(path?: readonly string[]): Promise<Chapter>; }

Loader for authored DSL guidance.

  • load(path?: readonly string[]): Promise<Chapter>

    Load an authored DSL chapter from the embedded bundle.

T
Help.Lib = { readonly Root: Root.Lib; readonly Dsl: Dsl.Lib; }

Runtime surface for bundled package help resources.

  • Dsl: Dsl.Lib
    No documentation available
  • Root: Root.Lib
    No documentation available
T
Help.Root.Guidance = { readonly summary: string; readonly sections: readonly Section[]; }

Authored root help used by package-owned formatters or CLIs.

  • sections: readonly Section[]
    No documentation available
  • summary: string
    No documentation available
T
Help.Root.Lib = { load(): Promise<Guidance>; }

Loader for authored root help.

  • load(): Promise<Guidance>

    Load authored root help from the embedded bundle.

T
Help.Section = t.Cli.Fmt.Chapters.Section

Authored help section with display label and ordered items.

T
PiTool.CliArgs = t.Tools.CliArgs

Command line arguments (argv).

T
PiTool.CliParsedArgs = t.ParsedArgs<CliArgs>
No documentation available
T
PiTool.Id = ID
No documentation available
T
PiTool.Name = NAME
No documentation available
T
PullTool.Bundle.Dist.Failure = MaterializationFailure | ProjectionFailure

Failure in generation materialization or later mutable projection.

T
PullTool.Bundle.Dist.MaterializationFailure = { readonly ok: false; readonly kind: "materialization-failed"; readonly generation: t.Dist.Failed; readonly projection: Projection.NotRun; }

Server-owned materialization failed, so projection never acquired authority to run.

  • generation: t.Dist.Failed
    No documentation available
  • kind: "materialization-failed"
    No documentation available
  • ok: false
    No documentation available
  • projection: Projection.NotRun
    No documentation available
T
PullTool.Bundle.Dist.Projection.Failure = { readonly kind: "failed"; readonly reason:
"invalid-target"
| "target-occupied"
| "filesystem-failure"
| "rewrite-failure"
| "cancelled"
; readonly dir: t.StringAbsoluteDir; readonly mode: t.GithubPull.Mode; readonly error: string; }

Projection failed after the pinned generation outcome had settled.

  • dir: t.StringAbsoluteDir
    No documentation available
  • error: string
    No documentation available
  • kind: "failed"
    No documentation available
  • mode: t.GithubPull.Mode
    No documentation available
  • reason:
    "invalid-target"
    | "target-occupied"
    | "filesystem-failure"
    | "rewrite-failure"
    | "cancelled"
    No documentation available
T
PullTool.Bundle.Dist.Projection.NotRequested = { readonly kind: "not-requested"; }

Projection was absent from configuration.

  • kind: "not-requested"
    No documentation available
T
PullTool.Bundle.Dist.Projection.NotRun = { readonly kind: "not-run"; }

Projection could not run because materialization failed.

  • kind: "not-run"
    No documentation available
T
PullTool.Bundle.Dist.Projection.Success = { readonly kind: "projected"; readonly dir: t.StringAbsoluteDir; readonly mode: t.GithubPull.Mode; }

Mutable local projection completed without inheriting a verification claim.

  • dir: t.StringAbsoluteDir
    No documentation available
  • kind: "projected"
    No documentation available
  • mode: t.GithubPull.Mode
    No documentation available
T
PullTool.Bundle.Dist.ProjectionFailure = { readonly ok: false; readonly kind: "projection-failed"; readonly generation: t.Dist.Existing | t.Dist.Promoted; readonly projection: Projection.Failure; }

Pinned generation succeeded, but its separate mutable projection failed.

  • generation: t.Dist.Existing | t.Dist.Promoted
    No documentation available
  • kind: "projection-failed"
    No documentation available
  • ok: false
    No documentation available
  • projection: Projection.Failure
    No documentation available
T
PullTool.Bundle.Dist.Result = Success | Failure

Complete materialization and projection settlement.

T
PullTool.Bundle.Dist.Success = { readonly ok: true; readonly kind: "dist"; readonly generation: t.Dist.Existing | t.Dist.Promoted; readonly projection: Projection.NotRequested | Projection.Success; }

Pinned generation success with either no projection or a completed projection.

  • generation: t.Dist.Existing | t.Dist.Promoted
    No documentation available
  • kind: "dist"
    No documentation available
  • ok: true
    No documentation available
  • projection: Projection.NotRequested | Projection.Success
    No documentation available
T
PullTool.Bundle.RunOptions = { readonly silent?: boolean; readonly until?: t.UntilInput; }

Lifecycle and terminal-output options for one bundle.

  • silent: boolean
    No documentation available
  • until: t.UntilInput
    No documentation available
T
PullTool.CliArgs =
t.Tools.CliArgs
& { config?: string; manifest?: string; integrity?: string; store?: string; project?: string; mode?: t.GithubPull.Mode; dry-run?: boolean; non-interactive?: boolean; }

Raw Pull command-line arguments.

T
PullTool.CliCommand = "add"

Supported Pull subcommand.

T
PullTool.CliParsedArgs =
t.ParsedArgs<CliArgs>
& { readonly command?: CliCommand; readonly interactive: boolean; }

Parsed Pull arguments with normalized interaction mode.

T
PullTool.ConfigYaml.Bundle = DistBundle | GithubReleaseBundle | GithubRepoBundle

One supported configured remote bundle.

T
PullTool.ConfigYaml.DirName = `-config/${string}.${Id}`

Canonical Pull configuration directory name.

T
PullTool.ConfigYaml.DistBundle = { kind: "dist"; manifest: t.StringUrl; integrity: t.StringHash; store: t.StringRelativeDir; project?: DistProject; }

Checksum-pinned Dist authority and optional mutable projection.

  • integrity: t.StringHash
    No documentation available
  • kind: "dist"
    No documentation available
  • manifest: t.StringUrl
    No documentation available
  • project: DistProject
    No documentation available
  • store: t.StringRelativeDir
    No documentation available
T
PullTool.ConfigYaml.DistProject = { dir: t.StringRelativeDir; mode: t.GithubPull.Mode; }

Optional mutable copy of a pinned Dist generation.

  • dir: t.StringRelativeDir
    No documentation available
  • mode: t.GithubPull.Mode
    No documentation available
T
PullTool.ConfigYaml.Doc = { dir: t.StringDir; bundles?: Bundle[]; }

Strict YAML document owned by Pull.

  • bundles: Bundle[]
    No documentation available
  • dir: t.StringDir
    No documentation available
T
PullTool.ConfigYaml.Ext = ".yaml"

Pull configuration filename extension.

T
PullTool.ConfigYaml.GithubBundleBase = { repo: string; local: GithubBundleLocal; limits: t.GithubPull.Limits; }

Authority shared by bounded generic GitHub bundles.

  • limits: t.GithubPull.Limits
    No documentation available
  • local: GithubBundleLocal
    No documentation available
  • repo: string
    No documentation available
T
PullTool.ConfigYaml.GithubBundleLocal = { dir: t.StringRelativeDir; mode: t.GithubPull.Mode; }

Explicit mutable target for a generic GitHub pull.

  • dir: t.StringRelativeDir
    No documentation available
  • mode: t.GithubPull.Mode
    No documentation available
T
PullTool.ConfigYaml.GithubReleaseBundle =
GithubBundleBase
& { kind: "github:release"; tag?: string; asset?: string | string[]; }

Bounded GitHub release-asset bundle.

T
PullTool.ConfigYaml.GithubRepoBundle =
GithubBundleBase
& { kind: "github:repo"; ref?: string; path?: string; }

Bounded GitHub repository-tree bundle.

T
PullTool.ConfigYaml.LoadResult =
{ readonly ok: true; readonly cwd: t.StringDir; readonly location: Location; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }

Pull configuration load result.

T
PullTool.ConfigYaml.Location = { readonly dir: t.StringDir; readonly bundles?: Bundle[]; }

Validated bundles with their resolved execution root.

  • bundles: Bundle[]
    No documentation available
  • dir: t.StringDir
    No documentation available
T
PullTool.ConfigYaml.Resolved = { readonly config: t.StringPath; readonly cwd: t.StringDir; readonly dir: t.StringDir; readonly localDirs: readonly ResolvedLocalDir[]; }

Resolved Pull configuration and its mutable output targets.

  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • dir: t.StringDir
    No documentation available
  • localDirs: readonly ResolvedLocalDir[]
    No documentation available
T
PullTool.ConfigYaml.ResolvedLocalDir = { readonly index: number; readonly dir: t.StringRelativeDir; readonly path: t.StringDir; readonly bundle: Bundle; }

Resolved mutable output target for a pull bundle.

  • bundle: Bundle
    No documentation available
  • dir: t.StringRelativeDir
    No documentation available
  • index: number
    No documentation available
  • path: t.StringDir
    No documentation available
T
PullTool.ConfigYaml.YamlCheck =
{ readonly ok: true; readonly doc: Doc; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }

Strict YAML validation result.

T
PullTool.Id = "pull"

Pull registry identifier literal.

T
PullTool.Lib = { resolve(config: t.StringPath): Promise<ConfigYaml.Resolved>; run(args: RunArgs): Promise<RunResult>; }

Public API for resolving and executing durable Pull configuration.

  • resolve(config: t.StringPath): Promise<ConfigYaml.Resolved>

    Resolve configured mutable outputs without network or filesystem mutation.

  • run(args: RunArgs): Promise<RunResult>

    Materialize every bundle in one owner config, throwing at the first failed bundle.

T
PullTool.MenuCmd =
"config"
| "config:edit"
| "config:rename"
| "bundle:add-dist"
| "back"
| "exit"

Command names.

T
PullTool.MenuOption = { readonly name: string; readonly value: MenuCmd; }

One interactive Pull menu option.

  • name: string
    No documentation available
  • value: MenuCmd
    No documentation available
T
PullTool.Name = "system/pull:tools"

Pull tool-name literal.

T
PullTool.RunArgs =
{ readonly cwd?: t.StringDir; readonly until?: t.UntilInput; }
& t.Tools.ConfigRefArgs

Arguments for a programmatic Pull run.

T
PullTool.RunBundleResult =
{ readonly bundle: ConfigYaml.DistBundle; readonly data: Bundle.Dist.Success; }
| { readonly bundle: ConfigYaml.GithubReleaseBundle | ConfigYaml.GithubRepoBundle; readonly data: t.GithubPull.Success; }

Successful result retained for one configured bundle; run throws on any bundle failure.

T
PullTool.RunResult = { readonly ok: true; readonly config: t.StringPath; readonly cwd: t.StringDir; readonly dir: t.StringDir; readonly bundles: readonly RunBundleResult[]; }

Successful settlement of every bundle in one programmatic Pull run.

  • bundles: readonly RunBundleResult[]
    No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • dir: t.StringDir
    No documentation available
  • ok: true
    No documentation available
T
ServeTool.CliArgs =
t.Tools.CliArgs
& { port?: number; dir?: string; config?: string; profile?: string; host?: Host; open?: boolean; non-interactive?: boolean; }

Command line arguments (argv).

T
ServeTool.CliParsedArgs = t.ParsedArgs<CliArgs> & { interactive: boolean; }
No documentation available
T
ServeTool.Command =
"dir:add"
| "dir:remove"
| "serve:start/local"
| "serve:start/network"
| "open"
| "reload"
| "back"
| "exit"

Command names.

T
ServeTool.Host = "local" | "network"

Programmatic server host policy.

T
ServeTool.Hostname = "127.0.0.1" | "0.0.0.0"

Concrete bind hostname derived from the host policy.

T
ServeTool.Id = ID
No documentation available
T
ServeTool.JsonView.File = { readonly kind: "file"; readonly body: { mime: t.StringMimeType; path: t.StringPath; hash: t.StringHash; bytes: t.NumberBytes; }; }
No documentation available
  • body: { mime: t.StringMimeType; path: t.StringPath; hash: t.StringHash; bytes: t.NumberBytes; }
    No documentation available
  • kind: "file"
    No documentation available
T
ServeTool.JsonView.Folder = { readonly kind: "folder"; readonly body: { dir: t.StringName; files: t.StringName[]; about: { pkg: t.Pkg; cmd: "serve"; }; }; }
No documentation available
  • body: { dir: t.StringName; files: t.StringName[]; about: { pkg: t.Pkg; cmd: "serve"; }; }
    No documentation available
  • kind: "folder"
    No documentation available
T
ServeTool.JsonView.Result = File | Folder
No documentation available
T
ServeTool.Lib = { start(args: StartArgs): Promise<StartResult>; }

Public serve helper API.

  • start(args: StartArgs): Promise<StartResult>

    Start a static serve target from a directory, config path, or named profile.

T
ServeTool.LocationYaml.DirName = `-config/${string}.serve`

Filesystem conventions for serve location YAML storage.

T
ServeTool.LocationYaml.Doc = { name: string; dir: t.StringDir; info?: Record<string, string>; }

YAML document structure for a serve location.

  • dir: t.StringDir

    Directory to serve (relative to CLI cwd, or absolute).

  • info: Record<string, string>

    Extra human-facing server info; path-like values decorate the served URL.

  • name: string

    Display name.

T
ServeTool.LocationYaml.Ext = ".yaml"
No documentation available
T
ServeTool.LocationYaml.LoadResult =
{ readonly ok: true; readonly cwd: t.StringDir; readonly location: Location; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }
No documentation available
T
ServeTool.LocationYaml.Location = { readonly name: string; readonly dir: t.StringDir; readonly info?: Record<string, string>; }

Runtime location with resolved paths.

  • dir: t.StringDir

    Resolved absolute directory to serve.

  • info: Record<string, string>

    Extra human-facing server info; path-like values decorate the served URL.

  • name: string

    Display name.

T
ServeTool.LocationYaml.YamlCheck =
{ readonly ok: true; readonly doc: Doc; }
| { readonly ok: false; readonly errors: readonly t.Schema.Error[]; }
No documentation available
T
ServeTool.MenuOption = { name: string; value: Command; }
No documentation available
  • name: string
    No documentation available
  • value: Command
    No documentation available
T
ServeTool.Name = NAME
No documentation available
T
ServeTool.RouteView = "json"

Alternative view formats for rendering a route.

T
ServeTool.StartArgs = StartArgsBase & StartSelectorArgs
No documentation available
T
ServeTool.StartArgsBase = { cwd?: t.StringDir; host?: Host; port?: number; until?: t.UntilInput; }
No documentation available
  • cwd: t.StringDir
    No documentation available
  • host: Host
    No documentation available
  • port: number

    Use 0 to let the runtime choose an available port.

  • until: t.UntilInput

    Canonical @sys lifecycle bridge.

T
ServeTool.StartConfigArgs = { config: t.StringPath; paths?: StartConfigPathsInput; dir?: never; profile?: never; }
No documentation available
  • config: t.StringPath

    Explicit serve YAML config path.

  • dir: never
    No documentation available
  • paths: StartConfigPathsInput

    Equivalent owner config ref; accepted only when it resolves to the same path.

  • profile: never
    No documentation available
T
ServeTool.StartConfigPaths = { config: t.StringPath; }

Owner config refs supplied by programmatic lifecycle callers.

  • config: t.StringPath
    No documentation available
T
ServeTool.StartConfigPathsInput = { config?: t.StringPath; }

Optional owner config refs for selector alias compatibility.

  • config: t.StringPath
    No documentation available
T
ServeTool.StartDirArgs = { dir: t.StringDir; config?: never; profile?: never; paths?: never; }
No documentation available
  • config: never
    No documentation available
  • dir: t.StringDir

    Serve this directory directly, resolved relative to cwd.

  • paths: never
    No documentation available
  • profile: never
    No documentation available
T
ServeTool.StartPathsConfigArgs = { paths: StartConfigPaths; dir?: never; config?: never; profile?: never; }
No documentation available
  • config: never
    No documentation available
  • dir: never
    No documentation available
  • paths: StartConfigPaths

    Owner config refs supplied by programmatic lifecycle callers.

  • profile: never
    No documentation available
T
ServeTool.StartProfileArgs = { profile: string; dir?: never; config?: never; paths?: never; }
No documentation available
  • config: never
    No documentation available
  • dir: never
    No documentation available
  • paths: never
    No documentation available
  • profile: string

    Bare serve config profile name under -config/@sys.tools.serve.

T
ServeTool.StartResult = { readonly ok: true; readonly cwd: t.StringDir; readonly selector: StartTargetSelector; readonly config?: t.StringPath; readonly location: LocationYaml.Location; readonly host: Host; readonly hostname: Hostname; readonly port: number; readonly baseUrl: t.StringUrl; readonly url: t.StringUrl; readonly finished: Promise<void>; readonly close: (reason?: unknown) => Promise<void>; status(): t.Service.Status; }
No documentation available
  • baseUrl: t.StringUrl
    No documentation available
  • close: (reason?: unknown) => Promise<void>
    No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • finished: Promise<void>
    No documentation available
  • host: Host
    No documentation available
  • hostname: Hostname
    No documentation available
  • location: LocationYaml.Location
    No documentation available
  • ok: true
    No documentation available
  • port: number
    No documentation available
  • selector: StartTargetSelector
    No documentation available
  • status(): t.Service.Status

    Renderer-neutral service status snapshot.

  • url: t.StringUrl
    No documentation available
T
ServeTool.StartSelectorArgs =
StartDirArgs
| StartConfigArgs
| StartPathsConfigArgs
| StartProfileArgs
No documentation available
T
ServeTool.StartServerOpts = { readonly port?: number; readonly host?: Host; readonly silent?: boolean; readonly keyboard?: boolean; readonly until?: t.UntilInput; }

Low-level static server start options.

  • host: Host
    No documentation available
  • keyboard: boolean
    No documentation available
  • port: number
    No documentation available
  • silent: boolean
    No documentation available
  • until: t.UntilInput
    No documentation available
T
ServeTool.StartServingContext = { readonly location: LocationYaml.Location; readonly host: Host; readonly hostname: Hostname; readonly port: number; readonly baseUrl: t.StringUrl; readonly url: t.StringUrl; readonly server: Deno.HttpServer<Deno.NetAddr>; readonly close: (reason?: unknown) => Promise<void>; }

Running low-level static server context.

  • baseUrl: t.StringUrl
    No documentation available
  • close: (reason?: unknown) => Promise<void>
    No documentation available
  • host: Host
    No documentation available
  • hostname: Hostname
    No documentation available
  • location: LocationYaml.Location
    No documentation available
  • port: number
    No documentation available
  • server: Deno.HttpServer<Deno.NetAddr>
    No documentation available
  • url: t.StringUrl
    No documentation available
T
ServeTool.StartTarget = { readonly cwd: t.StringDir; readonly selector: StartTargetSelector; readonly config?: t.StringPath; readonly location: LocationYaml.Location; }
No documentation available
  • config: t.StringPath
    No documentation available
  • cwd: t.StringDir
    No documentation available
  • location: LocationYaml.Location
    No documentation available
  • selector: StartTargetSelector
    No documentation available
T
ServeTool.StartTargetInput = { dir?: string; config?: string; profile?: string; paths?: StartTargetPathsInput; }
No documentation available
  • config: string
    No documentation available
  • dir: string
    No documentation available
  • paths: StartTargetPathsInput
    No documentation available
  • profile: string
    No documentation available
T
ServeTool.StartTargetPathsInput = { config?: string; }

Permissive raw target input used before selector normalization.

  • config: string
    No documentation available
T
ServeTool.StartTargetSelector =
{ readonly kind: "dir"; readonly input: string; readonly dir: t.StringDir; }
| { readonly kind: "config"; readonly config: t.StringPath; }
| { readonly kind: "profile"; readonly profile: string; readonly config: t.StringPath; }
No documentation available
T
ShellTool.Aftercare = { readonly source: string; readonly verify: string; }

Post-write instructions for activating shell profile changes.

  • source: string
    No documentation available
  • verify: string
    No documentation available
T
ShellTool.Alias.Command = "list" | "enable"
No documentation available
T
ShellTool.Alias.EnablePlan = { readonly kind: t.Shell.Plan["kind"]; readonly changed: boolean; readonly block: BlockState; readonly preview: string; }
No documentation available
  • block: BlockState
    No documentation available
  • changed: boolean
    No documentation available
  • kind: t.Shell.Plan["kind"]
    No documentation available
  • preview: string
    No documentation available
T
ShellTool.Alias.EnableReport = { readonly owner: Owner; readonly status: MutationStatus; readonly dryRun: boolean; readonly target: Target; readonly entries: readonly Entry[]; readonly profile?: Doctor.Profile; readonly backup?: t.StringPath; readonly plan?: EnablePlan; readonly aftercare?: Aftercare; readonly warnings: readonly string[]; }
No documentation available
  • aftercare: Aftercare
    No documentation available
  • backup: t.StringPath
    No documentation available
  • dryRun: boolean
    No documentation available
  • entries: readonly Entry[]
    No documentation available
  • owner: Owner
    No documentation available
  • plan: EnablePlan
    No documentation available
  • profile: Doctor.Profile
    No documentation available
  • status: MutationStatus
    No documentation available
  • target: Target
    No documentation available
  • warnings: readonly string[]
    No documentation available
T
ShellTool.Alias.Entry = t.Shell.Alias.Entry
No documentation available
T
ShellTool.Alias.Item = { readonly entry: Entry; readonly state: State; readonly profiles: readonly t.StringPath[]; readonly conflictProfiles: readonly t.StringPath[]; readonly stale: boolean; }
No documentation available
  • conflictProfiles: readonly t.StringPath[]
    No documentation available
  • entry: Entry
    No documentation available
  • profiles: readonly t.StringPath[]
    No documentation available
  • stale: boolean
    No documentation available
  • state: State
    No documentation available
T
ShellTool.Alias.Lib = { list(): Promise<ListReport>; enable(
target: Target,
options?: MutationOptions
): Promise<EnableReport>; }
No documentation available
  • enable(
    target: Target,
    options?: MutationOptions
    ): Promise<EnableReport>

    Enable aliases in the managed shell block, or preview with --dry-run.

  • list(): Promise<ListReport>

    Inspect the managed alias catalog and profile-managed alias state.

T
ShellTool.Alias.ListReport = { readonly owner: Owner; readonly shell: Doctor.ShellInfo; readonly profiles: readonly Doctor.Profile[]; readonly items: readonly Item[]; readonly warnings: readonly string[]; }
No documentation available
  • items: readonly Item[]
    No documentation available
  • owner: Owner
    No documentation available
  • profiles: readonly Doctor.Profile[]
    No documentation available
  • shell: Doctor.ShellInfo
    No documentation available
  • warnings: readonly string[]
    No documentation available
T
ShellTool.Alias.ParsedCommand =
{ readonly command: "list"; }
| { readonly command: "enable"; readonly target?: Target; }
No documentation available
T
ShellTool.Alias.State = "enabled" | "missing" | "conflict"
No documentation available
T
ShellTool.Alias.Target = "sys" | "common"
No documentation available
T
ShellTool.Apply.Aftercare = ShellTool.Aftercare
No documentation available
T
ShellTool.Apply.Options = MutationOptions
No documentation available
T
ShellTool.Apply.Plan = { readonly kind: t.Shell.Plan["kind"]; readonly changed: boolean; readonly block: BlockState; readonly preview: string; }
No documentation available
  • block: BlockState
    No documentation available
  • changed: boolean
    No documentation available
  • kind: t.Shell.Plan["kind"]
    No documentation available
  • preview: string
    No documentation available
T
ShellTool.Apply.Report = { readonly owner: Owner; readonly status: Status; readonly dryRun: boolean; readonly shell: Doctor.ShellInfo; readonly env: Doctor.EnvInfo; readonly aliases: readonly Alias.Entry[]; readonly paths: readonly Path.Entry[]; readonly profile?: Doctor.Profile; readonly backup?: t.StringPath; readonly plan?: Plan; readonly aftercare?: Aftercare; readonly warnings: readonly string[]; }
No documentation available
  • aftercare: Aftercare
    No documentation available
  • aliases: readonly Alias.Entry[]
    No documentation available
  • backup: t.StringPath
    No documentation available
  • dryRun: boolean
    No documentation available
  • env: Doctor.EnvInfo
    No documentation available
  • owner: Owner
    No documentation available
  • paths: readonly Path.Entry[]
    No documentation available
  • plan: Plan
    No documentation available
  • profile: Doctor.Profile
    No documentation available
  • shell: Doctor.ShellInfo
    No documentation available
  • status: Status
    No documentation available
  • warnings: readonly string[]
    No documentation available
T
ShellTool.Apply.Status = MutationStatus
No documentation available
T
ShellTool.Apply.WriteOptions = { readonly force?: boolean; }
No documentation available
  • force: boolean
    No documentation available
T
ShellTool.BlockState = t.Shell.Block.State

Existing managed block state from @sys/cli/shell.

T
ShellTool.CliArgs =
t.Tools.CliArgs
& { readonly dry-run?: boolean; readonly profile?: string; readonly shell?: string; }

Command line arguments (argv).

T
ShellTool.CliContext = { readonly origin?: "argv" | "root-menu"; }
No documentation available
  • origin: "argv" | "root-menu"
    No documentation available
T
ShellTool.CliParsedArgs =
t.ParsedArgs<CliArgs>
& { readonly command?: Command; readonly alias?: Alias.ParsedCommand; readonly path?: Path.ParsedCommand; }
No documentation available
T
ShellTool.CliResult = void | { readonly kind: "back"; }
No documentation available
T
ShellTool.Command = "doctor" | "alias" | "path" | "init" | "apply"

CLI sub-commands (first positional token).

T
ShellTool.Doctor.Catalog = { readonly aliases: readonly Alias.Entry[]; readonly paths: readonly Path.Entry[]; }
No documentation available
  • aliases: readonly Alias.Entry[]
    No documentation available
  • paths: readonly Path.Entry[]
    No documentation available
T
ShellTool.Doctor.EnvInfo = { readonly home?: t.StringDir; readonly denoInstall?: t.StringDir; readonly denoBin?: t.StringDir; readonly pathContainsDenoBin: boolean; }
No documentation available
T
ShellTool.Doctor.Profile = { readonly path: t.StringPath; readonly role: string; readonly exists: boolean; readonly block: BlockState; }
No documentation available
  • block: BlockState
    No documentation available
  • exists: boolean
    No documentation available
  • path: t.StringPath
    No documentation available
  • role: string
    No documentation available
T
ShellTool.Doctor.Report = { readonly owner: Owner; readonly shell: ShellInfo; readonly env: EnvInfo; readonly profiles: readonly Profile[]; readonly catalog: Catalog; readonly warnings: readonly string[]; }
No documentation available
  • catalog: Catalog
    No documentation available
  • env: EnvInfo
    No documentation available
  • owner: Owner
    No documentation available
  • profiles: readonly Profile[]
    No documentation available
  • shell: ShellInfo
    No documentation available
  • warnings: readonly string[]
    No documentation available
T
ShellTool.Doctor.ShellInfo = { readonly path?: string; readonly dialect?: PosixDialect; readonly support: Support; }
No documentation available
  • dialect: PosixDialect
    No documentation available
  • path: string
    No documentation available
  • support: Support
    No documentation available
T
ShellTool.Id = ID
No documentation available
T
ShellTool.Lib = { readonly Alias: Alias.Lib; readonly Path: Path.Lib; cli(
cwd?: t.StringDir,
argv?: string[],
context?: CliContext
): Promise<CliResult>; doctor(): Promise<Doctor.Report>; init(options?: Apply.Options): Promise<Apply.Report>; apply(options?: Apply.Options): Promise<Apply.Report>; }

Public shell tool helper surface.

  • Alias: Alias.Lib

    Alias catalog and managed-block mutation helpers.

  • Path: Path.Lib

    PATH catalog and managed-block mutation helpers.

  • apply(options?: Apply.Options): Promise<Apply.Report>
    No documentation available
  • cli(
    cwd?: t.StringDir,
    argv?: string[],
    context?: CliContext
    ): Promise<CliResult>

    Run the shell CLI flow.

  • doctor(): Promise<Doctor.Report>

    Run the read-only shell doctor.

  • init(options?: Apply.Options): Promise<Apply.Report>

    Initialize the recommended managed shell baseline.

T
ShellTool.MutationOptions = { readonly dryRun?: boolean; readonly profile?: t.StringPath; readonly shell?: PosixDialect; }

Mutation command options shared by planning/write flows.

  • dryRun: boolean
    No documentation available
  • profile: t.StringPath
    No documentation available
  • shell: PosixDialect
    No documentation available
T
ShellTool.MutationStatus = "planned" | "applied" | "unchanged" | "blocked"

Mutation lifecycle status.

T
ShellTool.Name = NAME
No documentation available
T
ShellTool.Owner = t.Shell.Owner

Managed block owner metadata.

T
ShellTool.Path.AddPlan = { readonly kind: t.Shell.Plan["kind"]; readonly changed: boolean; readonly block: BlockState; readonly preview: string; }
No documentation available
  • block: BlockState
    No documentation available
  • changed: boolean
    No documentation available
  • kind: t.Shell.Plan["kind"]
    No documentation available
  • preview: string
    No documentation available
T
ShellTool.Path.AddReport = { readonly owner: Owner; readonly status: MutationStatus; readonly dryRun: boolean; readonly target: Target; readonly entries: readonly Entry[]; readonly env: Doctor.EnvInfo; readonly profile?: Doctor.Profile; readonly backup?: t.StringPath; readonly plan?: AddPlan; readonly aftercare?: Aftercare; readonly warnings: readonly string[]; }
No documentation available
  • aftercare: Aftercare
    No documentation available
  • backup: t.StringPath
    No documentation available
  • dryRun: boolean
    No documentation available
  • entries: readonly Entry[]
    No documentation available
  • env: Doctor.EnvInfo
    No documentation available
  • owner: Owner
    No documentation available
  • plan: AddPlan
    No documentation available
  • profile: Doctor.Profile
    No documentation available
  • status: MutationStatus
    No documentation available
  • target: Target
    No documentation available
  • warnings: readonly string[]
    No documentation available
T
ShellTool.Path.Command = "list" | "add"
No documentation available
T
ShellTool.Path.Entry = t.Shell.Path.Entry
No documentation available
T
ShellTool.Path.Item = { readonly entry: Entry; readonly state: State; readonly profiles: readonly t.StringPath[]; readonly unmanagedProfiles: readonly t.StringPath[]; readonly stale: boolean; }
No documentation available
  • entry: Entry
    No documentation available
  • profiles: readonly t.StringPath[]
    No documentation available
  • stale: boolean
    No documentation available
  • state: State
    No documentation available
  • unmanagedProfiles: readonly t.StringPath[]
    No documentation available
T
ShellTool.Path.Lib = { list(): Promise<ListReport>; add(
target: Target,
options?: MutationOptions
): Promise<AddReport>; }
No documentation available
  • add(
    target: Target,
    options?: MutationOptions
    ): Promise<AddReport>

    Add PATH entries in the managed shell block, or preview with --dry-run.

  • list(): Promise<ListReport>

    Inspect the managed PATH catalog and profile-managed PATH state.

T
ShellTool.Path.ListReport = { readonly owner: Owner; readonly shell: Doctor.ShellInfo; readonly env: Doctor.EnvInfo; readonly profiles: readonly Doctor.Profile[]; readonly items: readonly Item[]; readonly warnings: readonly string[]; }
No documentation available
  • env: Doctor.EnvInfo
    No documentation available
  • items: readonly Item[]
    No documentation available
  • owner: Owner
    No documentation available
  • profiles: readonly Doctor.Profile[]
    No documentation available
  • shell: Doctor.ShellInfo
    No documentation available
  • warnings: readonly string[]
    No documentation available
T
ShellTool.Path.ParsedCommand =
{ readonly command: "list"; }
| { readonly command: "add"; readonly target?: Target; }
No documentation available
T
ShellTool.Path.State = "enabled" | "present" | "missing"
No documentation available
T
ShellTool.Path.Target = "deno"
No documentation available
T
ShellTool.PosixDialect = t.Shell.PosixDialect

POSIX-family dialects the shell planner can write today.

T
ShellTool.Support = "write" | "doctor-only" | "unsupported"

Write support available for a shell dialect.

T
TmplTool.CliArgs = t.Tools.CliArgs

Command line arguments (argv).

T
TmplTool.CliParsedArgs = t.ParsedArgs<CliArgs>
No documentation available
T
TmplTool.Id = ID
No documentation available
T
TmplTool.Name = NAME
No documentation available
T
Tools.CliArgs = { help: boolean; debug?: boolean; }

Common flags.

  • debug: boolean
    No documentation available
  • help: boolean
    No documentation available
T
Tools.CliRootArgs =
CliArgs
& { readonly noUpgradeCheck?: boolean; readonly no-upgrade-check?: boolean; }

Root-entry-only flags.

T
Tools.CliRootParsedArgs = t.ParsedArgs<CliRootArgs> & { readonly command?: Command; }

Root parse result (adds typed command from first positional).

T
Tools.Command =
t.ServeTool.Id
| t.ClipboardTool.Id
| t.PiTool.Id
| t.CryptoTool.Id
| t.CrdtTool.Id
| t.DeployTool.Id
| t.UpgradeTool.Id
| t.VideoTool.Id
| t.PullTool.Id
| t.ShellTool.Id
| t.TmplTool.Id
| "dsl"

Command names.

T
Tools.ConfigRefArgs =
{ readonly config: t.StringPath; readonly paths?: ConfigRefPathsInput; }
| { readonly config?: never; readonly paths: ConfigRefPaths; }

Programmatic config-ref selector accepted by finite tool endpoints.

T
Tools.ConfigRefPaths = { readonly config: t.StringPath; }

Owner config refs supplied by programmatic Cell/task callers.

  • config: t.StringPath
    No documentation available
T
Tools.ConfigRefPathsInput = { readonly config?: t.StringPath; }

Optional owner config refs for config alias compatibility.

  • config: t.StringPath
    No documentation available
T
Tools.Id = "tools"
No documentation available
T
Tools.Name = "system/tools"
No documentation available
T
Tools.Prompt.Dirs.MenuEntry = { readonly name: MenuLabel; readonly dir: t.StringDir; }
No documentation available
  • dir: t.StringDir
    No documentation available
  • name: MenuLabel
    No documentation available
T
Tools.Prompt.Dirs.MenuLabel = readonly [string, string]
No documentation available
T
Tools.Prompt.Dirs.RenderResult = { readonly label: string; readonly sortKey?: string; }
No documentation available
  • label: string
    No documentation available
  • sortKey: string
    No documentation available
T
Tools.Prompt.Dirs.RenderRow = (e: MenuEntry) => RenderResult
No documentation available
T
Tools.Recency = { createdAt?: t.UnixTimestamp; lastUsedAt?: t.UnixTimestamp; }

Usage timestamps for recency-aware behavior. Example: used by the core Config.orderByRecency helper.

T
UpgradeTool.AdvisoryRecord =
{ readonly schemaVersion: 2; readonly ok: true; readonly checkedAt: t.UnixTimestamp; readonly package: t.StringPkgName; readonly local: t.StringSemver; readonly published: t.StringSemver; readonly actionable?: t.StringSemver; readonly status: AdvisoryStatus; readonly reason?: t.WorkspaceResolve.PackageResolutionReason; readonly minimumDependencyAgeStanddown?: MinimumDependencyAgeStanddown; }
| { readonly schemaVersion: 2; readonly ok: false; readonly checkedAt: t.UnixTimestamp; readonly package: t.StringPkgName; readonly error: string; }

Cached advisory record persisted between root CLI startups.

T
UpgradeTool.AdvisoryStatus =
"none"
| "upgrade-available"
| "pending"
| "resolver-unavailable"

Cached advisory status persisted between root CLI startups.

T
UpgradeTool.CliArgs = t.Tools.CliArgs & { latest?: boolean; }

Command line arguments (argv).

T
UpgradeTool.CliContext = { readonly origin?: "argv" | "root-menu"; }
No documentation available
  • origin: "argv" | "root-menu"
    No documentation available
T
UpgradeTool.CliParsedArgs = t.ParsedArgs<CliArgs>
No documentation available
T
UpgradeTool.CliResult = void | { readonly kind: "back"; }
No documentation available
T
UpgradeTool.Id = "upgrade"
No documentation available
T
UpgradeTool.MinimumDependencyAgeStanddown = { readonly version: t.StringSemver; readonly createdAt: t.StringTimestamp; readonly minimumDependencyDate: t.StringTimestamp; readonly remaining: t.Msecs; }

Derived timing fact for a latest-version minimum dependency age standdown.

  • createdAt: t.StringTimestamp

    JSR creation timestamp for the latest published version.

  • minimumDependencyDate: t.StringTimestamp

    Deno resolver cutoff date for the active minimum dependency age policy.

  • remaining: t.Msecs

    Duration until the latest published version clears the active cutoff.

  • version: t.StringSemver

    Latest published version still inside the minimum dependency age window.

T
UpgradeTool.Name = "system/upgrade:tools"
No documentation available
T
UpgradeTool.VersionInfo = { readonly local: t.StringSemver; readonly remote: t.StringSemver; readonly remoteCreatedAt?: t.StringTimestamp; readonly latest: t.StringSemver; readonly actionable?: t.StringSemver; readonly resolution?: t.WorkspaceResolve.PackageResolutionFact; readonly latestResolution?: t.WorkspaceResolve.PackageResolutionFact; readonly is: { readonly latest: boolean; readonly upgradeAvailable?: boolean; readonly pending?: boolean; readonly resolverUnavailable?: boolean; }; }

Table of upgrade versions.

  • actionable: t.StringSemver

    Version Deno currently resolves under active config, lock, cache, and policy.

  • is: { readonly latest: boolean; readonly upgradeAvailable?: boolean; readonly pending?: boolean; readonly resolverUnavailable?: boolean; }
    No documentation available
  • latest: t.StringSemver

    Back-compat upgrade target; prefer actionable for new code.

  • latestResolution: t.WorkspaceResolve.PackageResolutionFact

    Raw Deno resolver fact for the published latest version when probing a standdown.

  • local: t.StringSemver

    Version of the currently executing @sys/tools package.

  • remote: t.StringSemver

    Latest version published by JSR registry metadata.

  • remoteCreatedAt: t.StringTimestamp

    JSR creation timestamp for the latest published version when reported by registry metadata.

  • resolution: t.WorkspaceResolve.PackageResolutionFact

    Raw Deno resolver fact for the unpinned package specifier when available.

T
UpgradeTool.VersionState = { readonly hasNewerRelease: boolean; readonly actionable?: t.StringSemver; readonly upgradeAvailable: boolean; readonly pending: boolean; readonly resolverUnavailable: boolean; readonly status: AdvisoryStatus; readonly reason?: t.WorkspaceResolve.PackageResolutionReason; readonly minimumDependencyAgeStanddown?: MinimumDependencyAgeStanddown; }

Derived upgrade truth state used by display, execution, and advisory persistence.

  • actionable: t.StringSemver

    Version Deno can currently execute after cache refresh.

  • hasNewerRelease: boolean

    True when JSR has published a version newer than the current CLI.

  • minimumDependencyAgeStanddown: MinimumDependencyAgeStanddown

    Proven minimum dependency age standdown timing for the latest published version.

  • pending: boolean

    True when a newer published release exists but no newer version is currently actionable.

  • reason: t.WorkspaceResolve.PackageResolutionReason

    Resolver reason when Deno reported one for the actionable or latest-version probe.

  • resolverUnavailable: boolean

    True when Deno could not verify an actionable version.

  • status: AdvisoryStatus

    Advisory-compatible status derived from the same truth flags.

  • upgradeAvailable: boolean

    True when there is an immediate Deno-actionable upgrade.

T
VideoTool.CliArgs = t.Tools.CliArgs

Command line arguments (argv).

T
VideoTool.CliParsedArgs = t.ParsedArgs<CliArgs>
No documentation available
T
VideoTool.Command = Conversion | "probe-file"

Command names.

T
VideoTool.Conversion = "webm-to-mp4" | "mp4-to-webm"

Supported video conversion directions.

T
VideoTool.Id = ID
No documentation available
T
VideoTool.MenuOption = { name: string; value: Command; }
No documentation available
  • name: string
    No documentation available
  • value: Command
    No documentation available
T
VideoTool.Mp4ToWebm = (args: { readonly src: string; readonly out?: string; readonly crf?: number; readonly opusKbps?: number; }) => Promise<string>

Convert: from .mp4 → .webm

T
VideoTool.Name = NAME
No documentation available
T
VideoTool.ProbeInfo = { readonly path: string; readonly formatName?: string; readonly formatLongName?: string; readonly durationSec?: number; readonly sizeBytes?: number; readonly bitRate?: number; readonly video?: { readonly codec?: string; readonly codecLongName?: string; readonly width?: number; readonly height?: number; readonly pixelFormat?: string; readonly profile?: string; readonly level?: number; readonly bitRate?: number; readonly avgFrameRate?: string; readonly rFrameRate?: string; readonly fps?: number; readonly colorSpace?: string; readonly colorTransfer?: string; readonly colorPrimaries?: string; readonly fieldOrder?: string; }; readonly audio?: { readonly codec?: string; readonly codecLongName?: string; readonly channels?: number; readonly channelLayout?: string; readonly sampleRate?: number; readonly bitRate?: number; }; }

Video probe meta-data information.

  • audio: { readonly codec?: string; readonly codecLongName?: string; readonly channels?: number; readonly channelLayout?: string; readonly sampleRate?: number; readonly bitRate?: number; }
    No documentation available
  • bitRate: number
    No documentation available
  • durationSec: number
    No documentation available
  • formatLongName: string
    No documentation available
  • formatName: string
    No documentation available
  • path: string
    No documentation available
  • sizeBytes: number
    No documentation available
  • video: { readonly codec?: string; readonly codecLongName?: string; readonly width?: number; readonly height?: number; readonly pixelFormat?: string; readonly profile?: string; readonly level?: number; readonly bitRate?: number; readonly avgFrameRate?: string; readonly rFrameRate?: string; readonly fps?: number; readonly colorSpace?: string; readonly colorTransfer?: string; readonly colorPrimaries?: string; readonly fieldOrder?: string; }
    No documentation available
T
VideoTool.WebmToMp4 = (args: { readonly src: string; readonly out?: string; readonly crf?: number; readonly aacKbps?: number; }) => Promise<string>

Convert: from .webm → .mp4

Variables

v
ClipboardTool.ID: "copy"
No documentation available
v
ClipboardTool.NAME: "system/copy:tools"
No documentation available
v
CrdtTool.ID: "crdt"
No documentation available
v
CrdtTool.NAME: "system/crdt:tools"
No documentation available
v
CryptoTool.ID: "crypto"
No documentation available
v
CryptoTool.NAME: "system/crypto:tools"
No documentation available
v
DeployTool.ID: "deploy"
No documentation available
v
DeployTool.NAME: "system/deploy:tools"
No documentation available
v
PiTool.ID: "pi"
No documentation available
v
PiTool.NAME: "system/pi:tools"
No documentation available
v
ServeTool.ID: "serve"
No documentation available
v
ServeTool.NAME: "system/serve:tools"
No documentation available
v
ShellTool.ID: "shell"
No documentation available
v
ShellTool.NAME: "system/shell:tools"
No documentation available
v
TmplTool.ID: "tmpl"
No documentation available
v
TmplTool.NAME: "system/tmpl:tools"
No documentation available
v
UpgradeTool.ID: "upgrade"
No documentation available
v
UpgradeTool.NAME: "system/upgrade:tools"
No documentation available
v
VideoTool.ID: "video"
No documentation available
v
VideoTool.NAME: "system/video:tools"
No documentation available

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@sys/tools

Import symbol

import * as tools from "@sys/tools";
or

Import directly with a jsr specifier

import * as tools from "jsr:@sys/tools";