intellibrix v1.0.0
    Preparing search index...

    Class default

    Class representing a Terminal Brick. It extends from the intellibrix!Brick class.

    It uses the TerminalKit library to interact with the terminal.

    const terminalBrick = new TerminalBrick({ logLevel: 'silent' })

    while (true) {
      terminalBrick.print('> ')
      const input = await terminalBrick.input()

      switch (input.toLowerCase()) {
        case 'exit':
          terminalBrick.printSuccess('Bye!')
          process.exit()
        case 'error':
          terminalBrick.printError('Error!')
          break
        case 'yellow':
          terminalBrick.terminal.yellow('Yellow!')
          break
        default:
          terminalBrick.printLine(`Command: ${input}`)
      }
    }

    Hierarchy

    • Brick
      • default
    Index
    constructor
    ai? db events id kit log name structure? terminal usage
    programs
    ask deprogram input keepAlive onInterrupt print printDebug printError printInfo printLine printSuccess printWarning program release run schedule task tools toolset unschedule use

    • Creates a new Terminal Brick.

      Parameters

      • options: BrickOptions = {}

        The options for the Terminal Brick.

      Returns default

    ai?: Intelligence

    The intelligence of the Brick instance. This is used to manage the AI capabilities of the Brick.

    db: KeyValueStore

    The key-value store of the Brick instance.

    events: EventEmitter

    The event emitter of the Brick instance. This is used to emit events that occur in the Brick, such as the running of a program.

    id: string

    The unique identifier of the Brick instance.

    kit: __module

    The TerminalKit module.

    log: Logger

    The logger used by the Brick instance. This is used to log information about the operation of the Brick.

    name: string

    The name of the Brick instance.

    structure?: Structure

    The parent Structure of the Brick instance, if any.

    terminal: Terminal

    The TerminalKit terminal instance.

    usage: UsageAccumulator

    Accumulates token usage/cost across every ask() call on this Brick. Starts as a .child() of this.ai.usage when an Intelligence is configured (so totals also roll up there), or standalone otherwise. Rebound as a .child() of the parent Structure's usage when added to one via Structure.add().

    • get programs(): { [key: string]: Program }

      Returns the private map of programs.

      Returns { [key: string]: Program }

    • Runs a prompt through this Brick's ai, offering its programs (via Brick.tools) plus any tools attached via Brick.use.

      Parameters

      • prompt: string
      • Optionaloptions: AskOptions

      Returns Promise<AskResult>

    • Removes a program from the private map of programs by its name.

      Parameters

      • name: string

        The name of the program to remove.

      Returns void

    • Prompts the user for input in the terminal.

      Parameters

      • inputOptions: InputFieldOptions = {}

        The options for the input field.

      Returns Promise<string>

      A promise that resolves to the user's input.

      InputClosedError if stdin ends (EOF, a closed pipe) or the user presses Ctrl+C before a line is entered.

    • Toggles the keep alive flag of the Brick instance, which will prevent the Node process from exiting

      Parameters

      • on: boolean

        A boolean indicating whether to turn the keep alive flag on or off.

      Returns void

      This is useful if you don't have a server or something else keeping the Node process alive.

    • Calls handler whenever the user presses Ctrl+C. TerminalKit puts the terminal in raw mode while it reads input, so Ctrl+C is delivered as a key instead of raising SIGINT.

      Parameters

      • handler: () => void

      Returns () => void

      A function that removes the handler.

    • Prints a debug message to the terminal in cyan color.

      Parameters

      • text: string

        The debug message to print.

      Returns void

    • Prints an error message to the terminal in red color.

      Parameters

      • text: string

        The error message to print.

      Returns void

    • Prints an info message to the terminal in blue color.

      Parameters

      • text: string

        The info message to print.

      Returns void

    • Prints a line of text to the terminal.

      Parameters

      • text: string

        The text to print.

      Returns void

    • Prints a success message to the terminal in green color.

      Parameters

      • text: string

        The success message to print.

      Returns void

    • Prints a warning message to the terminal in yellow color.

      Parameters

      • text: string

        The warning message to print.

      Returns void

    • Adds a program to the private map of programs.

      Parameters

      • program: Program

        The program to add.

      Returns void

    • Stops grabbing the terminal's input, restoring normal Ctrl+C handling and letting the process exit.

      Returns void

    • Runs a program by its name with a given payload.

      Parameters

      • name: string

        The name of the program to run.

      • payload: any

        The payload to pass to the program.

      Returns Promise<any>

      The result of the program.

    • Schedules a Task to run on a given schedule. This is a wrapper around the cron package.

      Parameters

      • task: Task

        The Task to schedule.

      Returns Task

      The scheduled task.

      The task will run on the schedule provided, and will run the method provided with the Brick instance as the first argument.

      An error if the task already exists.

    • Returns a Task by its name.

      Parameters

      • name: string

      Returns Task | undefined

    • Exposes every registered program as a ToolDefinition, each execute calling this.run(program.name, input).

      Returns ToolDefinition[]

    • Every tool this Brick offers: its programs (via Brick.tools) plus anything attached via Brick.use.

      Returns ToolDefinition[]

    • Unschedules a task by its name.

      Parameters

      • name: string

        The name of the task to unschedule.

      Returns void

      An error if the task does not exist.

    • Attaches external tool arrays (e.g. MCP-sourced tools) to this Brick, included whenever ask() builds its tool list.

      Parameters

      • ...toolsets: ToolDefinition[][]

      Returns this

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods