piral-cli/lib/common/config.d.ts

The standard CLI for creating and building a Piral instance or a Pilet.

import { AuthConfig, SourceLanguage, NpmClientType, PiletSchemaVersion } from '../types';
export interface PiralCliConfig {
    /**
     * Key to be used for all servers in case there is
     * no specialized key in apiKeys specified.
     */
    apiKey?: string;
    /**
     * Feed URL to API key specifications.
     */
    apiKeys?: Record<string, string>;
    /**
     * Emulator URL to auth options mapping.
     */
    auth?: Record<string, AuthConfig>;
    /**
     * URL to be used for publishing a pilet in case
     * there is no specialized key in url specified.
     */
    url?: string;
    /**
     * Path to a custom certificate file.
     */
    cert?: string;
    /**
     * Selects the default npm client to use.
     */
    npmClient?: NpmClientType;
    /**
     * Selects the default bundler to use, if
     * none given and found.
     */
    bundler?: string;
    /**
     * Selects the default pilet API path to use.
     */
    piletApi?: string;
    /**
     * Sets the validators configuration for a Piral instance.
     */
    validators?: Record<string, any>;
    /**
     * Sets the schema version to be used for pilets.
     */
    schemaVersion?: PiletSchemaVersion;
    /**
     * Automatically open the browser.
     */
    openBrowser?: boolean;
    /**
     * Port number.
     */
    port?: number;
    /**
     * Forces the set port to be used, otherwise exists with an error.
     */
    strictPort?: boolean;
    /**
     * Template language.
     */
    language?: SourceLanguage;
    /**
     * Host name.
     */
    host?: string;
    /**
     * Npm registry.
     */
    registry?: string;
    /**
     * Allow self-signed certificates.
     */
    allowSelfSigned?: boolean;
}
export declare const config: PiralCliConfig;
export declare function updateConfig<T extends keyof PiralCliConfig>(area: T, value: Partial<PiralCliConfig[T]>): Promise<void>;