mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-17 04:01:05 +00:00
86 lines
3.2 KiB
TypeScript
86 lines
3.2 KiB
TypeScript
import type { ChannelId } from "../channels/plugins/types.js";
|
|
import type { SecretInputMode } from "../plugins/provider-auth-types.js";
|
|
import type { GatewayDaemonRuntime } from "./daemon-runtime.js";
|
|
|
|
export type OnboardMode = "local" | "remote";
|
|
/**
|
|
* Auth choices are plugin-owned contract ids plus a few legacy aliases that
|
|
* are normalized elsewhere (for example `oauth` -> `setup-token`).
|
|
*/
|
|
export type BuiltInAuthChoice =
|
|
// Legacy alias for `setup-token` (kept for backwards CLI compatibility).
|
|
"oauth" | "setup-token" | "token" | "apiKey" | "custom-api-key" | "skip";
|
|
export type AuthChoice = BuiltInAuthChoice | (string & {});
|
|
|
|
/** Auth choice groups are plugin-owned ids plus the core `custom` bucket. */
|
|
export type AuthChoiceGroupId = "custom" | (string & {});
|
|
export type GatewayAuthChoice = "token" | "password";
|
|
export type ResetScope = "config" | "config+creds+sessions" | "full";
|
|
export type GatewayBind = "loopback" | "lan" | "auto" | "custom" | "tailnet";
|
|
export type TailscaleMode = "off" | "serve" | "funnel";
|
|
export type NodeManagerChoice = "npm" | "pnpm" | "bun";
|
|
export type ChannelChoice = ChannelId;
|
|
// Legacy alias (pre-rename).
|
|
export type ProviderChoice = ChannelChoice;
|
|
export type { SecretInputMode } from "../plugins/provider-auth-types.js";
|
|
|
|
type OnboardDynamicProviderOptions = {
|
|
/**
|
|
* Provider-specific non-interactive auth flags are plugin-owned and keyed by
|
|
* manifest `providerAuthChoices[].optionKey` values.
|
|
*/
|
|
[optionKey: string]: unknown;
|
|
};
|
|
|
|
export type OnboardOptions = OnboardDynamicProviderOptions & {
|
|
mode?: OnboardMode;
|
|
/** "manual" is an alias for "advanced". */
|
|
flow?: "quickstart" | "advanced" | "manual";
|
|
workspace?: string;
|
|
nonInteractive?: boolean;
|
|
/** Required for non-interactive setup; skips the interactive risk prompt when true. */
|
|
acceptRisk?: boolean;
|
|
reset?: boolean;
|
|
resetScope?: ResetScope;
|
|
authChoice?: AuthChoice;
|
|
/** Used when `authChoice=token` in non-interactive mode. */
|
|
tokenProvider?: string;
|
|
/** Used when `authChoice=token` in non-interactive mode. */
|
|
token?: string;
|
|
/** Used when `authChoice=token` in non-interactive mode. */
|
|
tokenProfileId?: string;
|
|
/** Used when `authChoice=token` in non-interactive mode. */
|
|
tokenExpiresIn?: string;
|
|
/** API key persistence mode for setup flows (default: plaintext). */
|
|
secretInputMode?: SecretInputMode;
|
|
arceeaiApiKey?: string;
|
|
cloudflareAiGatewayAccountId?: string;
|
|
cloudflareAiGatewayGatewayId?: string;
|
|
customBaseUrl?: string;
|
|
customApiKey?: string;
|
|
customModelId?: string;
|
|
customProviderId?: string;
|
|
customCompatibility?: "openai" | "anthropic";
|
|
gatewayPort?: number;
|
|
gatewayBind?: GatewayBind;
|
|
gatewayAuth?: GatewayAuthChoice;
|
|
gatewayToken?: string;
|
|
gatewayTokenRefEnv?: string;
|
|
gatewayPassword?: string;
|
|
tailscale?: TailscaleMode;
|
|
tailscaleResetOnExit?: boolean;
|
|
installDaemon?: boolean;
|
|
daemonRuntime?: GatewayDaemonRuntime;
|
|
skipChannels?: boolean;
|
|
/** @deprecated Legacy alias for `skipChannels`. */
|
|
skipProviders?: boolean;
|
|
skipSkills?: boolean;
|
|
skipSearch?: boolean;
|
|
skipHealth?: boolean;
|
|
skipUi?: boolean;
|
|
nodeManager?: NodeManagerChoice;
|
|
remoteUrl?: string;
|
|
remoteToken?: string;
|
|
json?: boolean;
|
|
};
|