ipfsd-ctl
    Preparing search index...

    Interface KuboOptions

    interface KuboOptions {
        args?: string[];
        bin?: string;
        clean?: unknown;
        disposable?: boolean;
        endpoint?: string;
        env?: Record<string, string>;
        init?: boolean | KuboInitOptions;
        repo?: string;
        start?: boolean | KuboStartOptions;
        stop?: KuboStopOptions;
        test?: boolean;
        type: "kubo";
        rpc?(...args: any[]): KuboRPCClient;
    }

    Hierarchy (View Summary)

    Index

    Properties

    args? bin? clean? disposable? endpoint? env? init? repo? start? stop? test? type

    Methods

    rpc?

    Properties

    args?: string[]

    Custom cli args

    bin?: string

    Path to a Kubo executable

    clean?: unknown

    Clean options

    disposable?: boolean

    A new repo is created and initialized for each invocation, as well as cleaned up automatically once the process exits

    endpoint?: string

    Where applicable, this endpoint will be used to spawn nodes remotely

    http://127.0.0.1:43134
    env?: Record<string, string>

    Additional environment variables, passed to executing shell. Only applies for Daemon controllers

    init?: boolean | KuboInitOptions

    Init options

    repo?: string

    The path to a repo directory. It will be created during init if it does not already exist.

    start?: boolean | KuboStartOptions

    Start options

    stop?: KuboStopOptions

    Stop options

    test?: boolean

    Flag to activate custom config for tests

    type: "kubo"

    The type of controller

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods