import * as Schema from "effect/Schema";
import type { FlagDoc, HelpDoc } from "effect/unstable/cli/HelpDoc";
export interface JsonFlagDoc {
    readonly name: string;
    readonly aliases: ReadonlyArray<string>;
    readonly type: string;
    readonly required: boolean;
    readonly description?: string | undefined;
}
export interface JsonArgDoc {
    readonly name: string;
    readonly type: string;
    readonly required: boolean;
    readonly variadic: boolean;
    readonly description?: string | undefined;
}
export interface JsonSubcommandDoc {
    readonly name: string;
    readonly alias?: string | undefined;
    readonly shortDescription?: string | undefined;
    readonly description?: string | undefined;
}
export interface JsonSubcommandGroupDoc {
    readonly group?: string | undefined;
    readonly commands: ReadonlyArray<JsonSubcommandDoc>;
}
export interface JsonExampleDoc {
    readonly command: string;
    readonly description?: string | undefined;
}
export interface JsonHelpDoc {
    readonly type: "help";
    readonly description: string;
    readonly usage: string;
    readonly flags: ReadonlyArray<JsonFlagDoc>;
    readonly globalFlags?: ReadonlyArray<JsonFlagDoc> | undefined;
    readonly args?: ReadonlyArray<JsonArgDoc> | undefined;
    readonly subcommands?: ReadonlyArray<JsonSubcommandGroupDoc> | undefined;
    readonly examples?: ReadonlyArray<JsonExampleDoc> | undefined;
    readonly learnMore?: string | undefined;
}
export declare const JsonFlagDocSchema: Schema.Struct<{
    readonly name: Schema.String;
    readonly aliases: Schema.$Array<Schema.String>;
    readonly type: Schema.String;
    readonly required: Schema.Boolean;
    readonly description: Schema.optional<Schema.String>;
}>;
export declare const JsonArgDocSchema: Schema.Struct<{
    readonly name: Schema.String;
    readonly type: Schema.String;
    readonly required: Schema.Boolean;
    readonly variadic: Schema.Boolean;
    readonly description: Schema.optional<Schema.String>;
}>;
export declare const JsonSubcommandDocSchema: Schema.Struct<{
    readonly name: Schema.String;
    readonly alias: Schema.optional<Schema.String>;
    readonly shortDescription: Schema.optional<Schema.String>;
    readonly description: Schema.optional<Schema.String>;
}>;
export declare const JsonSubcommandGroupDocSchema: Schema.Struct<{
    readonly group: Schema.optional<Schema.String>;
    readonly commands: Schema.$Array<Schema.Struct<{
        readonly name: Schema.String;
        readonly alias: Schema.optional<Schema.String>;
        readonly shortDescription: Schema.optional<Schema.String>;
        readonly description: Schema.optional<Schema.String>;
    }>>;
}>;
export declare const JsonExampleDocSchema: Schema.Struct<{
    readonly command: Schema.String;
    readonly description: Schema.optional<Schema.String>;
}>;
export declare const JsonHelpDocSchema: Schema.Struct<{
    readonly type: Schema.Literal<"help">;
    readonly description: Schema.String;
    readonly usage: Schema.String;
    readonly flags: Schema.$Array<Schema.Struct<{
        readonly name: Schema.String;
        readonly aliases: Schema.$Array<Schema.String>;
        readonly type: Schema.String;
        readonly required: Schema.Boolean;
        readonly description: Schema.optional<Schema.String>;
    }>>;
    readonly globalFlags: Schema.optional<Schema.$Array<Schema.Struct<{
        readonly name: Schema.String;
        readonly aliases: Schema.$Array<Schema.String>;
        readonly type: Schema.String;
        readonly required: Schema.Boolean;
        readonly description: Schema.optional<Schema.String>;
    }>>>;
    readonly args: Schema.optional<Schema.$Array<Schema.Struct<{
        readonly name: Schema.String;
        readonly type: Schema.String;
        readonly required: Schema.Boolean;
        readonly variadic: Schema.Boolean;
        readonly description: Schema.optional<Schema.String>;
    }>>>;
    readonly subcommands: Schema.optional<Schema.$Array<Schema.Struct<{
        readonly group: Schema.optional<Schema.String>;
        readonly commands: Schema.$Array<Schema.Struct<{
            readonly name: Schema.String;
            readonly alias: Schema.optional<Schema.String>;
            readonly shortDescription: Schema.optional<Schema.String>;
            readonly description: Schema.optional<Schema.String>;
        }>>;
    }>>>;
    readonly examples: Schema.optional<Schema.$Array<Schema.Struct<{
        readonly command: Schema.String;
        readonly description: Schema.optional<Schema.String>;
    }>>>;
    readonly learnMore: Schema.optional<Schema.String>;
}>;
export declare const JsonVersionDocSchema: Schema.Struct<{
    readonly type: Schema.Literal<"version">;
    readonly name: Schema.String;
    readonly version: Schema.String;
}>;
export type JsonVersionDoc = typeof JsonVersionDocSchema.Type;
export declare const isSubcommandDoc: (doc: HelpDoc) => boolean;
export declare const toJsonFlagDoc: (flag: FlagDoc) => JsonFlagDoc;
export declare const toJsonHelpDoc: (doc: HelpDoc, options?: {
    readonly learnMore?: string | undefined;
}) => JsonHelpDoc;
//# sourceMappingURL=json-help-doc.d.ts.map