mise API - v0.0.0
    Preparing search index...

    Interface ChellApi

    The chell command vocabulary as typed calls.

    Method names keep the shell's own verbs verbatim (ls, mkdir, rm): they are the projection's external schema, the same exemption the style guide grants wire field names. Every method resolves to the command's envelope; a failed command is an error-status envelope, never a throw.

    interface ChellApi {
        cat(
            paths: string | string[],
            options?: CatApiOptions,
        ): Promise<TypedEnvelope<"fs.cat">>;
        cd(path?: string): Promise<TypedEnvelope<"fs.cwd">>;
        cp(
            sources: string | string[],
            dest: string,
            options?: { recursive?: boolean },
        ): Promise<TypedEnvelope<"fs.cp">>;
        ls(
            paths?: string | string[],
            options?: LsApiOptions,
        ): Promise<TypedEnvelope<"fs.listing">>;
        mkdir(
            paths: string | string[],
            options?: { parents?: boolean },
        ): Promise<TypedEnvelope<"fs.mkdir">>;
        mv(
            sources: string | string[],
            dest: string,
        ): Promise<TypedEnvelope<"fs.mv">>;
        pwd(options?: { titles?: boolean }): Promise<TypedEnvelope<"fs.cwd">>;
        rm(
            paths: string | string[],
            options?: RmApiOptions,
        ): Promise<TypedEnvelope<"fs.rm">>;
        touch(
            path: string,
            options?: TouchApiOptions,
        ): Promise<TypedEnvelope<"fs.touch">>;
    }
    Index
    cat cd cp ls mkdir mv pwd rm touch

    • Prints one or more files; content arrives in the envelope's rendered channel, per-file outcomes in the model.

      Parameters

      • paths: string | string[]

        File path or paths.

      • Optionaloptions: CatApiOptions

        Binary handling.

      Returns Promise<TypedEnvelope<"fs.cat">>

      Envelope whose fs.cat model lists per-file outcomes.

    • Changes the session's working directory.

      Parameters

      • Optionalpath: string

        Target directory; omit for home, '-' for the previous cwd.

      Returns Promise<TypedEnvelope<"fs.cwd">>

      Envelope carrying the fs.cwd model on success.

    • Copies files or directories.

      Parameters

      • sources: string | string[]

        Source path or paths.

      • dest: string

        Destination path (a directory when several sources).

      • Optionaloptions: { recursive?: boolean }

        recursive copies directories.

      Returns Promise<TypedEnvelope<"fs.cp">>

      Envelope whose fs.cp model carries per-source outcomes.

    • Lists a directory (or several).

      Parameters

      • Optionalpaths: string | string[]

        Target path or paths; omit to list the session cwd.

      • Optionaloptions: LsApiOptions

        Sorting and presentation flags.

      Returns Promise<TypedEnvelope<"fs.listing">>

      Envelope whose fs.listing model carries entries per target.

    • Creates one or more directories.

      Parameters

      • paths: string | string[]

        Directory path or paths, absolute or cwd-relative.

      • Optionaloptions: { parents?: boolean }

        parents: make missing parents and accept a folder already there (mkdir -p); without it both are errors.

      Returns Promise<TypedEnvelope<"fs.mkdir">>

      Envelope whose fs.mkdir model lists per-target outcomes.

    • Moves or renames files or directories.

      Parameters

      • sources: string | string[]

        Source path or paths.

      • dest: string

        Destination path (a directory when several sources).

      Returns Promise<TypedEnvelope<"fs.mv">>

      Envelope whose fs.mv model carries per-source outcomes.

    • Reports the session's current working directory.

      Parameters

      • Optionaloptions: { titles?: boolean }

        titles substitutes feed/plugin titles into the path.

      Returns Promise<TypedEnvelope<"fs.cwd">>

      Envelope carrying the fs.cwd model.

    Settings
    Member Visibility

    On This Page
    Methods