mirror of
https://github.com/fosrl/pangolin.git
synced 2026-08-20 03:02:58 +02:00
Pass 1 of the config instructions
This commit is contained in:
Owen
@@ -0,0 +1,338 @@
|
||||
export const AI_CLIENT_IDS = ["claude", "codex", "opencode", "cursor"] as const;
|
||||
export type AiClientId = (typeof AI_CLIENT_IDS)[number];
|
||||
|
||||
export type AiClientAuth =
|
||||
| { mode: "keyed"; keyDisplay: string; getKeyText: () => Promise<string> }
|
||||
| { mode: "keyless" };
|
||||
|
||||
export type AiConfigBlock = {
|
||||
id: string;
|
||||
label: string;
|
||||
kind?: "code" | "steps";
|
||||
displayText: string;
|
||||
getCopyText?: () => Promise<string>;
|
||||
};
|
||||
|
||||
export type AiClientPresetId = "default" | "bedrock" | "vertex" | "kimi";
|
||||
|
||||
export type AiConfigPreset = {
|
||||
id: AiClientPresetId;
|
||||
label: string;
|
||||
blocks: AiConfigBlock[];
|
||||
};
|
||||
|
||||
export type AiCliCommands = {
|
||||
configure: AiConfigBlock;
|
||||
configureWithKey?: AiConfigBlock;
|
||||
run: AiConfigBlock;
|
||||
runWithKey?: AiConfigBlock;
|
||||
};
|
||||
|
||||
export type AiClientGuide = {
|
||||
id: AiClientId;
|
||||
name: string;
|
||||
cli: AiCliCommands | null;
|
||||
presets: AiConfigPreset[];
|
||||
};
|
||||
|
||||
function authValue(auth: AiClientAuth): {
|
||||
display: string;
|
||||
getCopyText?: () => Promise<string>;
|
||||
} {
|
||||
if (auth.mode === "keyed") {
|
||||
return { display: auth.keyDisplay, getCopyText: auth.getKeyText };
|
||||
}
|
||||
return { display: "-" };
|
||||
}
|
||||
|
||||
function block(
|
||||
id: string,
|
||||
label: string,
|
||||
build: (keyValue: string) => string,
|
||||
auth: AiClientAuth,
|
||||
kind: "code" | "steps" = "code"
|
||||
): AiConfigBlock {
|
||||
const { display, getCopyText } = authValue(auth);
|
||||
return {
|
||||
id,
|
||||
label,
|
||||
kind,
|
||||
displayText: build(display),
|
||||
getCopyText: getCopyText ? async () => build(await getCopyText()) : undefined
|
||||
};
|
||||
}
|
||||
|
||||
function buildCli(clientArg: "claude" | "codex", auth: AiClientAuth): AiCliCommands {
|
||||
const configure: AiConfigBlock = {
|
||||
id: `cli-configure-${clientArg}`,
|
||||
label: "Configure",
|
||||
displayText: `pangolin configure ${clientArg}`
|
||||
};
|
||||
const run: AiConfigBlock = {
|
||||
id: `cli-run-${clientArg}`,
|
||||
label: "Run",
|
||||
displayText: `pangolin run ${clientArg}`
|
||||
};
|
||||
|
||||
if (auth.mode !== "keyed") {
|
||||
return { configure, run };
|
||||
}
|
||||
|
||||
return {
|
||||
configure,
|
||||
run,
|
||||
configureWithKey: {
|
||||
id: `cli-configure-key-${clientArg}`,
|
||||
label: "Configure with an API key",
|
||||
displayText: `pangolin configure ${clientArg} ${auth.keyDisplay}`,
|
||||
getCopyText: async () =>
|
||||
`pangolin configure ${clientArg} ${await auth.getKeyText()}`
|
||||
},
|
||||
runWithKey: {
|
||||
id: `cli-run-key-${clientArg}`,
|
||||
label: "Run with an API key",
|
||||
displayText: `pangolin run ${clientArg} ${auth.keyDisplay}`,
|
||||
getCopyText: async () =>
|
||||
`pangolin run ${clientArg} ${await auth.getKeyText()}`
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
function buildClaudeGuide(endpoint: string, auth: AiClientAuth): AiClientGuide {
|
||||
const defaultSettings = block(
|
||||
"claude-default-settings",
|
||||
"~/.claude/settings.json",
|
||||
(key) =>
|
||||
[
|
||||
"{",
|
||||
` "apiKeyHelper": "echo '${key}'",`,
|
||||
' "env": {',
|
||||
` "ANTHROPIC_BASE_URL": "${endpoint}"`,
|
||||
" }",
|
||||
"}"
|
||||
].join("\n"),
|
||||
auth
|
||||
);
|
||||
|
||||
const defaultShell = block(
|
||||
"claude-default-shell",
|
||||
"Shell",
|
||||
(key) =>
|
||||
[
|
||||
`export ANTHROPIC_BASE_URL=${endpoint}`,
|
||||
`export ANTHROPIC_API_KEY=${auth.mode === "keyed" ? key : "none"}`,
|
||||
"claude"
|
||||
].join("\n"),
|
||||
auth
|
||||
);
|
||||
|
||||
const bedrockSettings = block(
|
||||
"claude-bedrock-settings",
|
||||
"~/.claude/settings.json",
|
||||
() =>
|
||||
[
|
||||
"{",
|
||||
' "env": {',
|
||||
' "ANTHROPIC_MODEL": "claude-sonnet-4-6",',
|
||||
` "ANTHROPIC_BEDROCK_BASE_URL": "${endpoint}/bedrock",`,
|
||||
' "CLAUDE_CODE_USE_BEDROCK": "1",',
|
||||
' "CLAUDE_CODE_SKIP_BEDROCK_AUTH": "1"',
|
||||
" }",
|
||||
"}"
|
||||
].join("\n"),
|
||||
auth
|
||||
);
|
||||
|
||||
const vertexSettings = block(
|
||||
"claude-vertex-settings",
|
||||
"~/.claude/settings.json",
|
||||
() =>
|
||||
[
|
||||
"{",
|
||||
' "env": {',
|
||||
' "CLOUD_ML_REGION": "global",',
|
||||
' "ANTHROPIC_VERTEX_PROJECT_ID": "<your-gcp-project-id>",',
|
||||
' "CLAUDE_CODE_USE_VERTEX": "1",',
|
||||
' "CLAUDE_CODE_SKIP_VERTEX_AUTH": "1",',
|
||||
` "ANTHROPIC_VERTEX_BASE_URL": "${endpoint}/v1"`,
|
||||
" }",
|
||||
"}"
|
||||
].join("\n"),
|
||||
auth
|
||||
);
|
||||
|
||||
const kimiSettings = block(
|
||||
"claude-kimi-settings",
|
||||
"~/.claude/settings.json",
|
||||
(key) =>
|
||||
[
|
||||
"{",
|
||||
` "apiKeyHelper": "echo '${key}'",`,
|
||||
' "env": {',
|
||||
` "ANTHROPIC_BASE_URL": "${endpoint}/anthropic",`,
|
||||
' "ANTHROPIC_MODEL": "kimi-k2",',
|
||||
' "ANTHROPIC_DEFAULT_OPUS_MODEL": "kimi-k2",',
|
||||
' "ANTHROPIC_DEFAULT_SONNET_MODEL": "kimi-k2",',
|
||||
' "ANTHROPIC_DEFAULT_HAIKU_MODEL": "kimi-k2",',
|
||||
' "CLAUDE_CODE_SUBAGENT_MODEL": "kimi-k2",',
|
||||
' "ENABLE_TOOL_SEARCH": "false"',
|
||||
" }",
|
||||
"}"
|
||||
].join("\n"),
|
||||
auth
|
||||
);
|
||||
|
||||
return {
|
||||
id: "claude",
|
||||
name: "Claude Code",
|
||||
cli: buildCli("claude", auth),
|
||||
presets: [
|
||||
{
|
||||
id: "default",
|
||||
label: "Default (Anthropic)",
|
||||
blocks: [defaultSettings, defaultShell]
|
||||
},
|
||||
{
|
||||
id: "bedrock",
|
||||
label: "Amazon Bedrock",
|
||||
blocks: [bedrockSettings]
|
||||
},
|
||||
{
|
||||
id: "vertex",
|
||||
label: "Google Vertex AI",
|
||||
blocks: [vertexSettings]
|
||||
},
|
||||
{
|
||||
id: "kimi",
|
||||
label: "Kimi K2 (Moonshot AI)",
|
||||
blocks: [kimiSettings]
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
|
||||
function buildCodexGuide(endpoint: string, auth: AiClientAuth): AiClientGuide {
|
||||
const settings = block(
|
||||
"codex-settings",
|
||||
"~/.codex/config.toml",
|
||||
() =>
|
||||
[
|
||||
'model_provider = "pangolin"',
|
||||
"",
|
||||
"[model_providers.pangolin]",
|
||||
'name = "Pangolin AI Gateway"',
|
||||
`base_url = "${endpoint}/v1"`,
|
||||
'wire_api = "responses"',
|
||||
...(auth.mode === "keyed" ? ['env_key = "PANGOLIN_API_KEY"'] : [])
|
||||
].join("\n"),
|
||||
auth
|
||||
);
|
||||
|
||||
const shell =
|
||||
auth.mode === "keyed"
|
||||
? block(
|
||||
"codex-shell",
|
||||
"Shell",
|
||||
(key) => `export PANGOLIN_API_KEY=${key}`,
|
||||
auth
|
||||
)
|
||||
: null;
|
||||
|
||||
return {
|
||||
id: "codex",
|
||||
name: "Codex",
|
||||
cli: buildCli("codex", auth),
|
||||
presets: [
|
||||
{
|
||||
id: "default",
|
||||
label: "Default",
|
||||
blocks: shell ? [settings, shell] : [settings]
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
|
||||
function buildOpencodeGuide(endpoint: string, auth: AiClientAuth): AiClientGuide {
|
||||
const config = block(
|
||||
"opencode-config",
|
||||
"opencode.json",
|
||||
() =>
|
||||
[
|
||||
"{",
|
||||
' "$schema": "https://opencode.ai/config.json",',
|
||||
' "provider": {',
|
||||
' "anthropic": {',
|
||||
' "options": {',
|
||||
` "baseURL": "${endpoint}/v1"`,
|
||||
" }",
|
||||
" }",
|
||||
" }",
|
||||
"}"
|
||||
].join("\n"),
|
||||
auth
|
||||
);
|
||||
|
||||
const authFile = block(
|
||||
"opencode-auth",
|
||||
"auth.json",
|
||||
(key) =>
|
||||
["{", ' "anthropic": {', ' "type": "api",', ` "key": "${key}"`, " }", "}"].join(
|
||||
"\n"
|
||||
),
|
||||
auth
|
||||
);
|
||||
|
||||
return {
|
||||
id: "opencode",
|
||||
name: "OpenCode",
|
||||
cli: null,
|
||||
presets: [
|
||||
{
|
||||
id: "default",
|
||||
label: "Default",
|
||||
blocks: [config, authFile]
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
|
||||
function buildCursorGuide(endpoint: string, auth: AiClientAuth): AiClientGuide {
|
||||
const steps = block(
|
||||
"cursor-steps",
|
||||
"Cursor Settings",
|
||||
(key) =>
|
||||
[
|
||||
"1. Open Cursor Settings -> Models.",
|
||||
'2. Enable "Override OpenAI Base URL".',
|
||||
`3. Set the base URL to: ${endpoint}/v1`,
|
||||
auth.mode === "keyed"
|
||||
? `4. Paste your API key into the OpenAI API Key field: ${key}`
|
||||
: '4. Leave the OpenAI API Key field set to a placeholder (e.g. "-"). Pangolin authenticates the request over your Newt/Olm connection automatically.',
|
||||
"5. Add a custom model matching the model your Pangolin AI Gateway serves (e.g. claude-sonnet-4-6)."
|
||||
].join("\n"),
|
||||
auth,
|
||||
"steps"
|
||||
);
|
||||
|
||||
return {
|
||||
id: "cursor",
|
||||
name: "Cursor",
|
||||
cli: null,
|
||||
presets: [
|
||||
{
|
||||
id: "default",
|
||||
label: "Default",
|
||||
blocks: [steps]
|
||||
}
|
||||
]
|
||||
};
|
||||
}
|
||||
|
||||
export function buildAiClientGuides(endpoint: string, auth: AiClientAuth): AiClientGuide[] {
|
||||
return [
|
||||
buildClaudeGuide(endpoint, auth),
|
||||
buildCodexGuide(endpoint, auth),
|
||||
buildOpencodeGuide(endpoint, auth),
|
||||
buildCursorGuide(endpoint, auth)
|
||||
];
|
||||
}
|
||||
Reference in New Issue
Block a user