Variable shellConst

Type Declaration

• condition: {
      and(...conditions: readonly ShellCondition[]): ShellCondition;
      commandExists(command: string): ShellCondition;
      directory(path: ShellValue): ShellCondition;
      empty(value: ShellValue): ShellCondition;
      executable(path: ShellValue): ShellCondition;
      file(path: ShellValue): ShellCondition;
      nonEmpty(value: ShellValue): ShellCondition;
      not(condition: ShellCondition): ShellCondition;
      or(...conditions: readonly ShellCondition[]): ShellCondition;
  }

  Construct conditions evaluated when the shell starts.

  • and: function

    • and(...conditions: readonly ShellCondition[]): ShellCondition

      Combine conditions with shell AND.

      Parameters

      • ...conditions: readonly ShellCondition[]

      Returns ShellCondition

  • commandExists: function

    • commandExists(command: string): ShellCondition

      Test whether a command is available on PATH.

      Parameters

      • command: string

      Returns ShellCondition

  • directory: function

    • directory(path: ShellValue): ShellCondition

      Test whether a path is a directory.

      Parameters

      • path: ShellValue

      Returns ShellCondition

  • empty: function

    • empty(value: ShellValue): ShellCondition

      Test whether a value is empty.

      Parameters

      • value: ShellValue

      Returns ShellCondition

  • executable: function

    • executable(path: ShellValue): ShellCondition

      Test whether a path is executable.

      Parameters

      • path: ShellValue

      Returns ShellCondition

  • file: function

    • file(path: ShellValue): ShellCondition

      Test whether a path is a regular file.

      Parameters

      • path: ShellValue

      Returns ShellCondition

  • nonEmpty: function

    • nonEmpty(value: ShellValue): ShellCondition

      Test whether a value is non-empty.

      Parameters

      • value: ShellValue

      Returns ShellCondition

  • not: function

    • not(condition: ShellCondition): ShellCondition

      Negate a condition.

      Parameters

      • condition: ShellCondition

      Returns ShellCondition

  • or: function

    • or(...conditions: readonly ShellCondition[]): ShellCondition

      Combine conditions with shell OR.

      Parameters

      • ...conditions: readonly ShellCondition[]

      Returns ShellCondition

• alias: function

  • alias(name: string, command: string): ShellStatement

    Define an alias; its command text is interpreted when the alias runs.

    Parameters

    • name: string
    • command: string

    Returns ShellStatement

• assign: function

  • assign(name: string, value: ShellValue): ShellStatement

    Set a shell variable without exporting it.

    Parameters

    • name: string
    • value: ShellValue

    Returns ShellStatement

• capture: function

  • capture(command: ShellCommand): ShellExpression

    Use a command's stdout as a value via command substitution.

    Parameters

    • command: ShellCommand

    Returns ShellExpression

• command: function

  • command(
        command: string,
        args?: readonly ShellValue[],
        options?: Pick<ShellCommand, "stderr">,
    ): ShellCommand

    Describe a command and its arguments. Use capture for its output or eval for initialization code.

    Parameters

    • command: string
    • args: readonly ShellValue[] = []
    • options: Pick<ShellCommand, "stderr"> = {}

    Returns ShellCommand

• concat: function

  • concat(...values: readonly ShellValue[]): ShellExpression

    Join literals and expressions into one shell value.

    Parameters

    • ...values: readonly ShellValue[]

    Returns ShellExpression

• eval: function

  • eval(command: ShellCommand): ShellStatement

    Evaluate shell code printed by a command.

    Parameters

    • command: ShellCommand

    Returns ShellStatement

    Example

    shell.eval(shell.command("mise", ["activate", "zsh"]))
    Copy

• export: function

  • export(name: string, value: ShellValue): ShellStatement

    Set and export an environment variable.

    Parameters

    • name: string
    • value: ShellValue

    Returns ShellStatement

• home: function

  • home(path?: string): ShellExpression

    Expand a path under the shell's HOME at runtime.

    Parameters

    • path: string = ""

    Returns ShellExpression

    Example

    shell.home(".local/bin")
    Copy

• keepPathFirst: function

  • keepPathFirst(...values: readonly ShellValue[]): ShellStatement

    Keep wrapper paths first after interactive environment hooks without duplicating hooks.

    Parameters

    • ...values: readonly ShellValue[]

    Returns ShellStatement

• prependPath: function

  • prependPath(...values: readonly ShellValue[]): ShellStatement

    Prepend paths while retaining the current PATH.

    Parameters

    • ...values: readonly ShellValue[]

    Returns ShellStatement

    Example

    shell.prependPath(shell.home(".local/bin"))
    Copy

• raw: function

  • raw(code: string): ShellStatement

    Insert literal shell code without validation or quoting. Prefer typed helpers for ordinary statements.

    Parameters

    • code: string

    Returns ShellStatement

• source: function

  • source(path: ShellValue, options?: { ifExists?: boolean }): ShellStatement

    Source another shell file. With ifExists: true, source only when readable.

    Parameters

    • path: ShellValue
    • options: { ifExists?: boolean } = {}

    Returns ShellStatement

• unset: function

  • unset(...names: readonly string[]): ShellStatement

    Remove one or more shell variables.

    Parameters

    • ...names: readonly string[]

    Returns ShellStatement

• variable: function

  • variable(name: string): ShellExpression

    Reference a shell variable at runtime.

    Parameters

    • name: string

    Returns ShellExpression

    Example

    shell.export("VISUAL", shell.variable("EDITOR"))
    Copy

• when: function

  • when(
        condition: ShellCondition,
        statements: readonly ShellStatement[],
    ): ShellStatement

    Generate a shell-time conditional containing one or more statements.

    Parameters

    • condition: ShellCondition
    • statements: readonly ShellStatement[]

    Returns ShellStatement