Config: {
    apiKey: string;
    autoshow: "svg" | "png" | "jpg" | "jpeg" | "pdf" | "json" | "gif" | "webp" | "tiff" | "tex" | "auto" | "graph" | "nodes" | "edges" | "decorations" | "constraints" | "data" | null;
    config: string;
    draft: boolean;
    exec: "batch" | "incremental" | "auto";
    format: "svg" | "png" | "jpg" | "jpeg" | "pdf" | "json" | "gif" | "webp" | "tiff" | "tex";
    height: number;
    model: string;
    orientation: "left" | "right" | "top" | "bottom" | "auto";
    provider: string;
    type: "streaming" | "single";
    width: number;
}

Type declaration

  • apiKey: string

    Model provider API key

  • autoshow: "svg" | "png" | "jpg" | "jpeg" | "pdf" | "json" | "gif" | "webp" | "tiff" | "tex" | "auto" | "graph" | "nodes" | "edges" | "decorations" | "constraints" | "data" | null

    If not false, automatically display graph after each command with this format (default: svg)

  • config: string

    Path to JSON configuration file (Default: ~/.graphmaker.json)

  • draft: boolean

    Display extra information, e.g., node reference names.

  • exec: "batch" | "incremental" | "auto"

    Determines how tasks are sent to the AI model in the :exec command: 'batch' [fewest requests], 'incremental' [one request per task], and 'auto' [model-dependent]

  • format: "svg" | "png" | "jpg" | "jpeg" | "pdf" | "json" | "gif" | "webp" | "tiff" | "tex"

    Default output format for :show/:save commands.

  • height: number

    Height of image canvas in pixels.

  • model: string

    Model to use ('gpt-3.5-turbo')

  • orientation: "left" | "right" | "top" | "bottom" | "auto"

    Default orientation for displaying the graph indicating where the first/root node is positioned (either 'left', 'right', 'top', 'bottom', or 'auto')

  • provider: string

    Model provider ('OpenAI')

  • type: "streaming" | "single"

    Model type ('streaming' or 'single')

  • width: number

    Width of image canvas in pixels.

Generated using TypeDoc