@arizeai/phoenix-cli 1.8.1 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -0
- package/build/cli.d.ts.map +1 -1
- package/build/cli.js +2 -1
- package/build/cli.js.map +1 -1
- package/build/client.d.ts +5 -1
- package/build/client.d.ts.map +1 -1
- package/build/client.js +2 -1
- package/build/client.js.map +1 -1
- package/build/commands/annotationConfig.d.ts.map +1 -1
- package/build/commands/annotationConfig.js.map +1 -1
- package/build/commands/{annotationMutationUtils.d.ts → annotationMutations.d.ts} +1 -1
- package/build/commands/annotationMutations.d.ts.map +1 -0
- package/build/commands/{annotationMutationUtils.js → annotationMutations.js} +1 -1
- package/build/commands/annotationMutations.js.map +1 -0
- package/build/commands/api.d.ts.map +1 -1
- package/build/commands/api.js.map +1 -1
- package/build/commands/auth.d.ts +1 -1
- package/build/commands/auth.d.ts.map +1 -1
- package/build/commands/auth.js +6 -12
- package/build/commands/auth.js.map +1 -1
- package/build/commands/dataset.d.ts.map +1 -1
- package/build/commands/dataset.js.map +1 -1
- package/build/commands/docs.d.ts +51 -0
- package/build/commands/docs.d.ts.map +1 -1
- package/build/commands/docs.js +86 -37
- package/build/commands/docs.js.map +1 -1
- package/build/commands/experiment.d.ts.map +1 -1
- package/build/commands/experiment.js.map +1 -1
- package/build/commands/fetchSpanAnnotations.d.ts +14 -0
- package/build/commands/fetchSpanAnnotations.d.ts.map +1 -0
- package/build/commands/fetchSpanAnnotations.js +57 -0
- package/build/commands/fetchSpanAnnotations.js.map +1 -0
- package/build/commands/fetchTraceAnnotations.d.ts +14 -0
- package/build/commands/fetchTraceAnnotations.d.ts.map +1 -0
- package/build/commands/fetchTraceAnnotations.js +57 -0
- package/build/commands/fetchTraceAnnotations.js.map +1 -0
- package/build/commands/formatAnnotationMutation.d.ts +1 -1
- package/build/commands/formatAnnotationMutation.d.ts.map +1 -1
- package/build/commands/formatNoteMutation.d.ts +1 -1
- package/build/commands/formatNoteMutation.d.ts.map +1 -1
- package/build/commands/formatSetup.d.ts +50 -0
- package/build/commands/formatSetup.d.ts.map +1 -0
- package/build/commands/formatSetup.js +64 -0
- package/build/commands/formatSetup.js.map +1 -0
- package/build/commands/index.d.ts +4 -3
- package/build/commands/index.d.ts.map +1 -1
- package/build/commands/index.js +4 -3
- package/build/commands/index.js.map +1 -1
- package/build/commands/{noteMutationUtils.d.ts → noteMutations.d.ts} +1 -1
- package/build/commands/noteMutations.d.ts.map +1 -0
- package/build/commands/{noteMutationUtils.js → noteMutations.js} +1 -1
- package/build/commands/noteMutations.js.map +1 -0
- package/build/commands/options.d.ts +248 -0
- package/build/commands/options.d.ts.map +1 -0
- package/build/commands/options.js +16 -0
- package/build/commands/options.js.map +1 -0
- package/build/commands/profile.d.ts.map +1 -1
- package/build/commands/profile.js +3 -11
- package/build/commands/profile.js.map +1 -1
- package/build/commands/project.d.ts.map +1 -1
- package/build/commands/project.js +0 -1
- package/build/commands/project.js.map +1 -1
- package/build/commands/prompt.d.ts.map +1 -1
- package/build/commands/prompt.js.map +1 -1
- package/build/commands/self.d.ts.map +1 -1
- package/build/commands/self.js.map +1 -1
- package/build/commands/session.d.ts.map +1 -1
- package/build/commands/session.js +4 -4
- package/build/commands/session.js.map +1 -1
- package/build/commands/{sessionAnnotationsCommand.d.ts → sessionAnnotations.d.ts} +1 -1
- package/build/commands/sessionAnnotations.d.ts.map +1 -0
- package/build/commands/{sessionAnnotationsCommand.js → sessionAnnotations.js} +1 -1
- package/build/commands/sessionAnnotations.js.map +1 -0
- package/build/commands/setup.d.ts +19 -0
- package/build/commands/setup.d.ts.map +1 -0
- package/build/commands/setup.js +245 -0
- package/build/commands/setup.js.map +1 -0
- package/build/commands/span.d.ts.map +1 -1
- package/build/commands/span.js +5 -5
- package/build/commands/span.js.map +1 -1
- package/build/commands/spanAnnotations.d.ts +6 -13
- package/build/commands/spanAnnotations.d.ts.map +1 -1
- package/build/commands/spanAnnotations.js +154 -47
- package/build/commands/spanAnnotations.js.map +1 -1
- package/build/commands/trace.d.ts.map +1 -1
- package/build/commands/trace.js +6 -6
- package/build/commands/trace.js.map +1 -1
- package/build/commands/traceAnnotations.d.ts +6 -13
- package/build/commands/traceAnnotations.d.ts.map +1 -1
- package/build/commands/traceAnnotations.js +157 -47
- package/build/commands/traceAnnotations.js.map +1 -1
- package/build/curl.d.ts +17 -0
- package/build/curl.d.ts.map +1 -1
- package/build/curl.js.map +1 -1
- package/build/optionParsers.d.ts +12 -0
- package/build/optionParsers.d.ts.map +1 -1
- package/build/optionParsers.js +15 -0
- package/build/optionParsers.js.map +1 -1
- package/build/pxi/App.d.ts.map +1 -1
- package/build/pxi/App.js +4 -0
- package/build/pxi/App.js.map +1 -1
- package/build/pxi/options.d.ts +98 -0
- package/build/pxi/options.d.ts.map +1 -1
- package/build/pxi/options.js.map +1 -1
- package/build/settings.d.ts.map +1 -1
- package/build/settings.js +4 -0
- package/build/settings.js.map +1 -1
- package/build/setup/agents/registry.d.ts +78 -0
- package/build/setup/agents/registry.d.ts.map +1 -0
- package/build/setup/agents/registry.js +129 -0
- package/build/setup/agents/registry.js.map +1 -0
- package/build/setup/copy.d.ts +167 -0
- package/build/setup/copy.d.ts.map +1 -0
- package/build/setup/copy.js +290 -0
- package/build/setup/copy.js.map +1 -0
- package/build/setup/deps/buildDefaultDeps.d.ts +13 -0
- package/build/setup/deps/buildDefaultDeps.d.ts.map +1 -0
- package/build/setup/deps/buildDefaultDeps.js +29 -0
- package/build/setup/deps/buildDefaultDeps.js.map +1 -0
- package/build/setup/deps/clipboard.d.ts +12 -0
- package/build/setup/deps/clipboard.d.ts.map +1 -0
- package/build/setup/deps/clipboard.js +30 -0
- package/build/setup/deps/clipboard.js.map +1 -0
- package/build/setup/deps/clock.d.ts +10 -0
- package/build/setup/deps/clock.d.ts.map +1 -0
- package/build/setup/deps/clock.js +11 -0
- package/build/setup/deps/clock.js.map +1 -0
- package/build/setup/deps/context.d.ts +28 -0
- package/build/setup/deps/context.d.ts.map +1 -0
- package/build/setup/deps/context.js +24 -0
- package/build/setup/deps/context.js.map +1 -0
- package/build/setup/deps/docs.d.ts +41 -0
- package/build/setup/deps/docs.d.ts.map +1 -0
- package/build/setup/deps/docs.js +33 -0
- package/build/setup/deps/docs.js.map +1 -0
- package/build/setup/deps/index.d.ts +42 -0
- package/build/setup/deps/index.d.ts.map +1 -0
- package/build/setup/deps/index.js +16 -0
- package/build/setup/deps/index.js.map +1 -0
- package/build/setup/deps/phoenixClient.d.ts +22 -0
- package/build/setup/deps/phoenixClient.d.ts.map +1 -0
- package/build/setup/deps/phoenixClient.js +17 -0
- package/build/setup/deps/phoenixClient.js.map +1 -0
- package/build/setup/deps/processes.d.ts +28 -0
- package/build/setup/deps/processes.d.ts.map +1 -0
- package/build/setup/deps/processes.js +58 -0
- package/build/setup/deps/processes.js.map +1 -0
- package/build/setup/deps/prompter.d.ts +42 -0
- package/build/setup/deps/prompter.d.ts.map +1 -0
- package/build/setup/deps/prompter.js +10 -0
- package/build/setup/deps/prompter.js.map +1 -0
- package/build/setup/errors.d.ts +27 -0
- package/build/setup/errors.d.ts.map +1 -0
- package/build/setup/errors.js +36 -0
- package/build/setup/errors.js.map +1 -0
- package/build/setup/options.d.ts +113 -0
- package/build/setup/options.d.ts.map +1 -0
- package/build/setup/options.js +63 -0
- package/build/setup/options.js.map +1 -0
- package/build/setup/prompts/instrumentationPrompt.d.ts +42 -0
- package/build/setup/prompts/instrumentationPrompt.d.ts.map +1 -0
- package/build/setup/prompts/instrumentationPrompt.js +64 -0
- package/build/setup/prompts/instrumentationPrompt.js.map +1 -0
- package/build/setup/runSetup.d.ts +45 -0
- package/build/setup/runSetup.d.ts.map +1 -0
- package/build/setup/runSetup.js +212 -0
- package/build/setup/runSetup.js.map +1 -0
- package/build/setup/steps/chooseEndpoint.d.ts +36 -0
- package/build/setup/steps/chooseEndpoint.d.ts.map +1 -0
- package/build/setup/steps/chooseEndpoint.js +125 -0
- package/build/setup/steps/chooseEndpoint.js.map +1 -0
- package/build/setup/steps/confirmGitSafety.d.ts +17 -0
- package/build/setup/steps/confirmGitSafety.d.ts.map +1 -0
- package/build/setup/steps/confirmGitSafety.js +73 -0
- package/build/setup/steps/confirmGitSafety.js.map +1 -0
- package/build/setup/steps/establishConnection.d.ts +29 -0
- package/build/setup/steps/establishConnection.d.ts.map +1 -0
- package/build/setup/steps/establishConnection.js +143 -0
- package/build/setup/steps/establishConnection.js.map +1 -0
- package/build/setup/steps/installTooling.d.ts +28 -0
- package/build/setup/steps/installTooling.d.ts.map +1 -0
- package/build/setup/steps/installTooling.js +79 -0
- package/build/setup/steps/installTooling.js.map +1 -0
- package/build/setup/steps/instrumentApp.d.ts +41 -0
- package/build/setup/steps/instrumentApp.d.ts.map +1 -0
- package/build/setup/steps/instrumentApp.js +131 -0
- package/build/setup/steps/instrumentApp.js.map +1 -0
- package/build/setup/steps/offerPxProfile.d.ts +20 -0
- package/build/setup/steps/offerPxProfile.d.ts.map +1 -0
- package/build/setup/steps/offerPxProfile.js +95 -0
- package/build/setup/steps/offerPxProfile.js.map +1 -0
- package/build/setup/steps/prefetchDocs.d.ts +24 -0
- package/build/setup/steps/prefetchDocs.d.ts.map +1 -0
- package/build/setup/steps/prefetchDocs.js +49 -0
- package/build/setup/steps/prefetchDocs.js.map +1 -0
- package/build/setup/steps/verifyTraces.d.ts +44 -0
- package/build/setup/steps/verifyTraces.d.ts.map +1 -0
- package/build/setup/steps/verifyTraces.js +119 -0
- package/build/setup/steps/verifyTraces.js.map +1 -0
- package/build/setup/steps/writeEnvFile.d.ts +19 -0
- package/build/setup/steps/writeEnvFile.d.ts.map +1 -0
- package/build/setup/steps/writeEnvFile.js +50 -0
- package/build/setup/steps/writeEnvFile.js.map +1 -0
- package/build/setup/ui/clackPrompter.d.ts +11 -0
- package/build/setup/ui/clackPrompter.d.ts.map +1 -0
- package/build/setup/ui/clackPrompter.js +107 -0
- package/build/setup/ui/clackPrompter.js.map +1 -0
- package/build/setup/ui/selectBoolean.d.ts +18 -0
- package/build/setup/ui/selectBoolean.d.ts.map +1 -0
- package/build/setup/ui/selectBoolean.js +14 -0
- package/build/setup/ui/selectBoolean.js.map +1 -0
- package/build/setup/util/gitignoreCoverage.d.ts +24 -0
- package/build/setup/util/gitignoreCoverage.d.ts.map +1 -0
- package/build/setup/util/gitignoreCoverage.js +43 -0
- package/build/setup/util/gitignoreCoverage.js.map +1 -0
- package/build/setup/util/paths.d.ts +6 -0
- package/build/setup/util/paths.d.ts.map +1 -0
- package/build/setup/util/paths.js +23 -0
- package/build/setup/util/paths.js.map +1 -0
- package/build/setup/util/redact.d.ts +12 -0
- package/build/setup/util/redact.d.ts.map +1 -0
- package/build/setup/util/redact.js +31 -0
- package/build/setup/util/redact.js.map +1 -0
- package/build/validation/endpoint.d.ts +19 -0
- package/build/validation/endpoint.d.ts.map +1 -0
- package/build/validation/endpoint.js +39 -0
- package/build/validation/endpoint.js.map +1 -0
- package/package.json +15 -12
- package/build/commands/annotationMutationUtils.d.ts.map +0 -1
- package/build/commands/annotationMutationUtils.js.map +0 -1
- package/build/commands/noteMutationUtils.d.ts.map +0 -1
- package/build/commands/noteMutationUtils.js.map +0 -1
- package/build/commands/sessionAnnotationsCommand.d.ts.map +0 -1
- package/build/commands/sessionAnnotationsCommand.js.map +0 -1
- package/build/commands/spanAnnotationsCommand.d.ts +0 -7
- package/build/commands/spanAnnotationsCommand.d.ts.map +0 -1
- package/build/commands/spanAnnotationsCommand.js +0 -164
- package/build/commands/spanAnnotationsCommand.js.map +0 -1
- package/build/commands/traceAnnotationsCommand.d.ts +0 -7
- package/build/commands/traceAnnotationsCommand.d.ts.map +0 -1
- package/build/commands/traceAnnotationsCommand.js +0 -167
- package/build/commands/traceAnnotationsCommand.js.map +0 -1
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Choose the endpoint: where Phoenix is, and whether it wants an API key.
|
|
3
|
+
*
|
|
4
|
+
* Two options — Local or Remote ("paste your instance URL"). The probe is
|
|
5
|
+
* an unauthenticated
|
|
6
|
+
* `GET /v1/projects?limit=1`: 200 → auth off, 401/403 → auth on, anything
|
|
7
|
+
* else → troubleshoot copy and re-ask (max 3 attempts).
|
|
8
|
+
*/
|
|
9
|
+
import { HttpError } from "@arizeai/phoenix-client";
|
|
10
|
+
import { isEndpointUrl, normalizeEndpoint } from "../../validation/endpoint.js";
|
|
11
|
+
import * as COPY from "../copy.js";
|
|
12
|
+
import { HeadlessInputError, SetupCancelledError, SetupFatalError, } from "../errors.js";
|
|
13
|
+
import { redactForDisplay } from "../util/redact.js";
|
|
14
|
+
const PROBE_TIMEOUT_MS = 10_000;
|
|
15
|
+
const MAX_ATTEMPTS = 3;
|
|
16
|
+
const DEFAULT_LOCAL_ENDPOINT = "http://localhost:6006";
|
|
17
|
+
/**
|
|
18
|
+
* Probe an endpoint to determine reachability and whether auth is enabled.
|
|
19
|
+
*/
|
|
20
|
+
export async function probeEndpoint(deps, endpoint) {
|
|
21
|
+
const client = deps.createClient({ endpoint });
|
|
22
|
+
try {
|
|
23
|
+
await client.GET("/v1/projects", {
|
|
24
|
+
params: { query: { limit: 1 } },
|
|
25
|
+
signal: AbortSignal.timeout(PROBE_TIMEOUT_MS),
|
|
26
|
+
});
|
|
27
|
+
return { kind: "authOff" };
|
|
28
|
+
}
|
|
29
|
+
catch (error) {
|
|
30
|
+
if (error instanceof HttpError) {
|
|
31
|
+
if (error.status === 401 || error.status === 403) {
|
|
32
|
+
return { kind: "authOn" };
|
|
33
|
+
}
|
|
34
|
+
return { kind: "notPhoenix", detail: `HTTP ${error.status}` };
|
|
35
|
+
}
|
|
36
|
+
// A 2xx whose body will not parse: something is listening, but it is not
|
|
37
|
+
// the Phoenix API.
|
|
38
|
+
if (error instanceof SyntaxError) {
|
|
39
|
+
return { kind: "notPhoenix", detail: COPY.ENDPOINT.unexpectedBody };
|
|
40
|
+
}
|
|
41
|
+
return { kind: "unreachable", detail: redactForDisplay(String(error)) };
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
async function promptForEndpoint(deps) {
|
|
45
|
+
const choice = await deps.prompter.select({
|
|
46
|
+
message: COPY.ENDPOINT.selectMessage,
|
|
47
|
+
options: [
|
|
48
|
+
{
|
|
49
|
+
value: "local",
|
|
50
|
+
label: COPY.ENDPOINT.localLabel,
|
|
51
|
+
hint: COPY.ENDPOINT.localHint,
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
value: "remote",
|
|
55
|
+
label: COPY.ENDPOINT.remoteLabel,
|
|
56
|
+
hint: COPY.ENDPOINT.remoteHint,
|
|
57
|
+
},
|
|
58
|
+
],
|
|
59
|
+
});
|
|
60
|
+
if (choice === "local") {
|
|
61
|
+
return DEFAULT_LOCAL_ENDPOINT;
|
|
62
|
+
}
|
|
63
|
+
const url = await deps.prompter.textInput({
|
|
64
|
+
message: COPY.ENDPOINT.remoteUrlMessage,
|
|
65
|
+
validate: (value) => isEndpointUrl(value) ? undefined : COPY.ENDPOINT.remoteUrlInvalid,
|
|
66
|
+
});
|
|
67
|
+
return url;
|
|
68
|
+
}
|
|
69
|
+
export async function chooseEndpoint(deps, { presetEndpoint, headless }) {
|
|
70
|
+
let attempts = 0;
|
|
71
|
+
let candidate = presetEndpoint;
|
|
72
|
+
for (;;) {
|
|
73
|
+
if (candidate === undefined) {
|
|
74
|
+
if (headless) {
|
|
75
|
+
throw new HeadlessInputError(COPY.ENDPOINT.headlessNeedsEndpoint);
|
|
76
|
+
}
|
|
77
|
+
candidate = await promptForEndpoint(deps);
|
|
78
|
+
}
|
|
79
|
+
let endpoint;
|
|
80
|
+
try {
|
|
81
|
+
endpoint = normalizeEndpoint(candidate);
|
|
82
|
+
}
|
|
83
|
+
catch {
|
|
84
|
+
if (headless) {
|
|
85
|
+
throw new HeadlessInputError(COPY.ENDPOINT.remoteUrlInvalid);
|
|
86
|
+
}
|
|
87
|
+
deps.prompter.line(COPY.ENDPOINT.remoteUrlInvalid);
|
|
88
|
+
candidate = undefined;
|
|
89
|
+
continue;
|
|
90
|
+
}
|
|
91
|
+
deps.prompter.line(COPY.ENDPOINT.probing(endpoint));
|
|
92
|
+
const outcome = await probeEndpoint(deps, endpoint);
|
|
93
|
+
if (outcome.kind === "authOff") {
|
|
94
|
+
deps.prompter.line(COPY.ENDPOINT.authOff);
|
|
95
|
+
return { endpoint, authEnabled: false };
|
|
96
|
+
}
|
|
97
|
+
if (outcome.kind === "authOn") {
|
|
98
|
+
deps.prompter.line(COPY.ENDPOINT.authOn);
|
|
99
|
+
return { endpoint, authEnabled: true };
|
|
100
|
+
}
|
|
101
|
+
if (headless) {
|
|
102
|
+
throw new SetupFatalError(COPY.ENDPOINT.headlessUnreachable(endpoint));
|
|
103
|
+
}
|
|
104
|
+
attempts += 1;
|
|
105
|
+
deps.prompter.line(outcome.kind === "unreachable"
|
|
106
|
+
? COPY.ENDPOINT.unreachable(endpoint)
|
|
107
|
+
: COPY.ENDPOINT.notPhoenix(endpoint, outcome.detail));
|
|
108
|
+
if (attempts >= MAX_ATTEMPTS) {
|
|
109
|
+
deps.prompter.line(COPY.ENDPOINT.gaveUp);
|
|
110
|
+
throw new SetupCancelledError();
|
|
111
|
+
}
|
|
112
|
+
const retry = await deps.prompter.select({
|
|
113
|
+
message: COPY.ENDPOINT.retryMessage,
|
|
114
|
+
options: [
|
|
115
|
+
{ value: true, label: COPY.ENDPOINT.retryYes },
|
|
116
|
+
{ value: false, label: COPY.ENDPOINT.retryNo },
|
|
117
|
+
],
|
|
118
|
+
});
|
|
119
|
+
if (!retry) {
|
|
120
|
+
throw new SetupCancelledError();
|
|
121
|
+
}
|
|
122
|
+
candidate = undefined;
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
//# sourceMappingURL=chooseEndpoint.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"chooseEndpoint.js","sourceRoot":"","sources":["../../../src/setup/steps/chooseEndpoint.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,GAChB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAQlD,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAChC,MAAM,YAAY,GAAG,CAAC,CAAC;AACvB,MAAM,sBAAsB,GAAG,uBAAuB,CAAC;AAQvD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,IAAqC,EACrC,QAAgB;IAEhB,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE;YAC/B,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;YAC/B,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC;SAC9C,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACjD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YAC5B,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;QAChE,CAAC;QACD,yEAAyE;QACzE,mBAAmB;QACnB,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;QACtE,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;IAC1E,CAAC;AACH,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,IAAiC;IAEjC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAqB;QAC5D,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa;QACpC,OAAO,EAAE;YACP;gBACE,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU;gBAC/B,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;aAC9B;YACD;gBACE,KAAK,EAAE,QAAQ;gBACf,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW;gBAChC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU;aAC/B;SACF;KACF,CAAC,CAAC;IACH,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,OAAO,sBAAsB,CAAC;IAChC,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,gBAAgB;QACvC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAClB,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB;KACpE,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAQD,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,IAAkD,EAClD,EAAE,cAAc,EAAE,QAAQ,EAAsB;IAEhD,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,SAAS,GAAG,cAAc,CAAC;IAE/B,SAAS,CAAC;QACR,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;YACpE,CAAC;YACD,SAAS,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,QAAgB,CAAC;QACrB,IAAI,CAAC;YACH,QAAQ,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAC/D,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YACnD,SAAS,GAAG,SAAS,CAAC;YACtB,SAAS;QACX,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEpD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC1C,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;QAC1C,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzC,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;QACzC,CAAC;QAED,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzE,CAAC;QAED,QAAQ,IAAI,CAAC,CAAC;QACd,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,OAAO,CAAC,IAAI,KAAK,aAAa;YAC5B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC;YACrC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CACvD,CAAC;QAEF,IAAI,QAAQ,IAAI,YAAY,EAAE,CAAC;YAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACzC,MAAM,IAAI,mBAAmB,EAAE,CAAC;QAClC,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAU;YAChD,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY;YACnC,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;gBAC9C,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;aAC/C;SACF,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,mBAAmB,EAAE,CAAC;QAClC,CAAC;QACD,SAAS,GAAG,SAAS,CAAC;IACxB,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Confirm git can undo whatever setup is about to do.
|
|
3
|
+
*
|
|
4
|
+
* A coding agent may be about to edit files in this directory; git is the
|
|
5
|
+
* undo button. Both gates are opt-in selects with the safe option first.
|
|
6
|
+
* Headless mode proceeds only on a clean repo.
|
|
7
|
+
*/
|
|
8
|
+
import type { SetupDeps } from "../deps/index.js";
|
|
9
|
+
export interface GitSafetyResult {
|
|
10
|
+
isGitRepository: boolean;
|
|
11
|
+
/** False when the user chose to stop at a gate. */
|
|
12
|
+
proceed: boolean;
|
|
13
|
+
}
|
|
14
|
+
export declare function confirmGitSafety(deps: Pick<SetupDeps, "context" | "processes" | "prompter">, { headless }: {
|
|
15
|
+
headless: boolean;
|
|
16
|
+
}): Promise<GitSafetyResult>;
|
|
17
|
+
//# sourceMappingURL=confirmGitSafety.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"confirmGitSafety.d.ts","sourceRoot":"","sources":["../../../src/setup/steps/confirmGitSafety.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAIzC,MAAM,WAAW,eAAe;IAC9B,eAAe,EAAE,OAAO,CAAC;IACzB,mDAAmD;IACnD,OAAO,EAAE,OAAO,CAAC;CAClB;AAID,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,CAAC,EAC3D,EAAE,QAAQ,EAAE,EAAE;IAAE,QAAQ,EAAE,OAAO,CAAA;CAAE,GAClC,OAAO,CAAC,eAAe,CAAC,CAmE1B"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Confirm git can undo whatever setup is about to do.
|
|
3
|
+
*
|
|
4
|
+
* A coding agent may be about to edit files in this directory; git is the
|
|
5
|
+
* undo button. Both gates are opt-in selects with the safe option first.
|
|
6
|
+
* Headless mode proceeds only on a clean repo.
|
|
7
|
+
*/
|
|
8
|
+
import * as COPY from "../copy.js";
|
|
9
|
+
import { SetupFatalError } from "../errors.js";
|
|
10
|
+
import { selectBoolean } from "../ui/selectBoolean.js";
|
|
11
|
+
const MAX_LISTED_FILES = 20;
|
|
12
|
+
export async function confirmGitSafety(deps, { headless }) {
|
|
13
|
+
const repoCheck = await deps.processes.exec({
|
|
14
|
+
command: "git",
|
|
15
|
+
args: ["rev-parse", "--is-inside-work-tree"],
|
|
16
|
+
cwd: deps.context.cwd,
|
|
17
|
+
});
|
|
18
|
+
const isGitRepository = repoCheck.exitCode === 0 && repoCheck.stdout.trim() === "true";
|
|
19
|
+
if (!isGitRepository) {
|
|
20
|
+
// `git` missing entirely is treated the same as "not a repo".
|
|
21
|
+
if (headless) {
|
|
22
|
+
throw new SetupFatalError(COPY.GIT.headlessNotARepo);
|
|
23
|
+
}
|
|
24
|
+
const proceed = await selectBoolean({
|
|
25
|
+
prompter: deps.prompter,
|
|
26
|
+
message: COPY.GIT.notARepoMessage,
|
|
27
|
+
noFirst: true,
|
|
28
|
+
noLabel: COPY.GIT.notARepoNo,
|
|
29
|
+
noHint: COPY.GIT.notARepoNoHint,
|
|
30
|
+
yesLabel: COPY.GIT.notARepoYes,
|
|
31
|
+
yesHint: COPY.GIT.notARepoYesHint,
|
|
32
|
+
});
|
|
33
|
+
if (!proceed) {
|
|
34
|
+
deps.prompter.line(COPY.GIT.stopped);
|
|
35
|
+
}
|
|
36
|
+
return { isGitRepository, proceed };
|
|
37
|
+
}
|
|
38
|
+
const statusCheck = await deps.processes.exec({
|
|
39
|
+
command: "git",
|
|
40
|
+
args: ["status", "--porcelain=v1"],
|
|
41
|
+
cwd: deps.context.cwd,
|
|
42
|
+
});
|
|
43
|
+
const dirtyPaths = statusCheck.stdout
|
|
44
|
+
.split("\n")
|
|
45
|
+
.map((line) => line.trim())
|
|
46
|
+
.filter(Boolean);
|
|
47
|
+
if (dirtyPaths.length === 0) {
|
|
48
|
+
return { isGitRepository, proceed: true };
|
|
49
|
+
}
|
|
50
|
+
if (headless) {
|
|
51
|
+
throw new SetupFatalError(COPY.GIT.headlessDirty);
|
|
52
|
+
}
|
|
53
|
+
const shown = dirtyPaths.slice(0, MAX_LISTED_FILES);
|
|
54
|
+
const lines = [...shown];
|
|
55
|
+
if (dirtyPaths.length > MAX_LISTED_FILES) {
|
|
56
|
+
lines.push(COPY.GIT.andMore(dirtyPaths.length - MAX_LISTED_FILES));
|
|
57
|
+
}
|
|
58
|
+
deps.prompter.note(lines.join("\n"), COPY.GIT.dirtyFileListTitle);
|
|
59
|
+
const proceed = await selectBoolean({
|
|
60
|
+
prompter: deps.prompter,
|
|
61
|
+
message: COPY.GIT.dirtyMessage(dirtyPaths.length),
|
|
62
|
+
noFirst: true,
|
|
63
|
+
noLabel: COPY.GIT.dirtyNo,
|
|
64
|
+
noHint: COPY.GIT.dirtyNoHint,
|
|
65
|
+
yesLabel: COPY.GIT.dirtyYes,
|
|
66
|
+
yesHint: COPY.GIT.dirtyYesHint,
|
|
67
|
+
});
|
|
68
|
+
if (!proceed) {
|
|
69
|
+
deps.prompter.line(COPY.GIT.stopped);
|
|
70
|
+
}
|
|
71
|
+
return { isGitRepository, proceed };
|
|
72
|
+
}
|
|
73
|
+
//# sourceMappingURL=confirmGitSafety.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"confirmGitSafety.js","sourceRoot":"","sources":["../../../src/setup/steps/confirmGitSafety.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAQpD,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,IAA2D,EAC3D,EAAE,QAAQ,EAAyB;IAEnC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QAC1C,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,CAAC,WAAW,EAAE,uBAAuB,CAAC;QAC5C,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;KACtB,CAAC,CAAC;IACH,MAAM,eAAe,GACnB,SAAS,CAAC,QAAQ,KAAK,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,MAAM,CAAC;IAEjE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,8DAA8D;QAC9D,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;YAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,eAAe;YACjC,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU;YAC5B,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc;YAC/B,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW;YAC9B,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,eAAe;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,CAAC;IACtC,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QAC5C,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC;QAClC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;KACtB,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM;SAClC,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnB,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;IACpD,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IACzB,IAAI,UAAU,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAElE,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC;QAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC;QACjD,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO;QACzB,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW;QAC5B,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ;QAC3B,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,CAAC;AACtC,CAAC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Establish the connection.
|
|
3
|
+
*
|
|
4
|
+
* The project itself is never created here — Phoenix creates a project on
|
|
5
|
+
* first ingestion, so setup only needs to settle on a *name* and hand it
|
|
6
|
+
* to the app via `PHOENIX_PROJECT_NAME`. What remains is credential
|
|
7
|
+
* acquisition: the auth-on lanes verify the key with a read-only probe so a
|
|
8
|
+
* bad paste is caught here rather than at first trace. Future OAuth
|
|
9
|
+
* acquisition plugs into the auth-on interactive lane unchanged.
|
|
10
|
+
*/
|
|
11
|
+
import type { SetupDeps } from "../deps/index.js";
|
|
12
|
+
import type { SetupInputs } from "../options.js";
|
|
13
|
+
export interface Connection {
|
|
14
|
+
/** Normalized origin, no trailing slash. */
|
|
15
|
+
endpoint: string;
|
|
16
|
+
projectName: string;
|
|
17
|
+
/** Present iff auth is enabled on the deployment. */
|
|
18
|
+
apiKey?: string;
|
|
19
|
+
}
|
|
20
|
+
/** Names are used as URL path identifiers; '/', '?', '#' are invalid. */
|
|
21
|
+
export declare function validateProjectName(value: string): string | undefined;
|
|
22
|
+
export declare function defaultProjectName(cwd: string): string;
|
|
23
|
+
export interface EstablishConnectionArgs {
|
|
24
|
+
endpoint: string;
|
|
25
|
+
authEnabled: boolean;
|
|
26
|
+
inputs: SetupInputs;
|
|
27
|
+
}
|
|
28
|
+
export declare function establishConnection(deps: Pick<SetupDeps, "context" | "createClient" | "prompter">, { endpoint, authEnabled, inputs }: EstablishConnectionArgs): Promise<Connection>;
|
|
29
|
+
//# sourceMappingURL=establishConnection.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"establishConnection.d.ts","sourceRoot":"","sources":["../../../src/setup/steps/establishConnection.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAMH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAG9C,MAAM,WAAW,UAAU;IACzB,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAQD,yEAAyE;AACzE,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMrE;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGtD;AA+ID,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,WAAW,CAAC;CACrB;AAED,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,cAAc,GAAG,UAAU,CAAC,EAC9D,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,uBAAuB,GACzD,OAAO,CAAC,UAAU,CAAC,CAgBrB"}
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Establish the connection.
|
|
3
|
+
*
|
|
4
|
+
* The project itself is never created here — Phoenix creates a project on
|
|
5
|
+
* first ingestion, so setup only needs to settle on a *name* and hand it
|
|
6
|
+
* to the app via `PHOENIX_PROJECT_NAME`. What remains is credential
|
|
7
|
+
* acquisition: the auth-on lanes verify the key with a read-only probe so a
|
|
8
|
+
* bad paste is caught here rather than at first trace. Future OAuth
|
|
9
|
+
* acquisition plugs into the auth-on interactive lane unchanged.
|
|
10
|
+
*/
|
|
11
|
+
import * as path from "node:path";
|
|
12
|
+
import { HttpError } from "@arizeai/phoenix-client";
|
|
13
|
+
import * as COPY from "../copy.js";
|
|
14
|
+
import { HeadlessInputError, SetupFatalError } from "../errors.js";
|
|
15
|
+
import { redactForDisplay } from "../util/redact.js";
|
|
16
|
+
const REST_TIMEOUT_MS = 10_000;
|
|
17
|
+
// ---------------------------------------------------------------------------
|
|
18
|
+
// Project name
|
|
19
|
+
// ---------------------------------------------------------------------------
|
|
20
|
+
/** Names are used as URL path identifiers; '/', '?', '#' are invalid. */
|
|
21
|
+
export function validateProjectName(value) {
|
|
22
|
+
const trimmed = value.trim();
|
|
23
|
+
if (!trimmed || /[/?#]/.test(trimmed)) {
|
|
24
|
+
return COPY.CONNECT.projectNameInvalid;
|
|
25
|
+
}
|
|
26
|
+
return undefined;
|
|
27
|
+
}
|
|
28
|
+
export function defaultProjectName(cwd) {
|
|
29
|
+
const base = path.basename(cwd).replace(/[/?#]/g, "-").trim();
|
|
30
|
+
return base || "default";
|
|
31
|
+
}
|
|
32
|
+
async function promptForProjectName(deps, inputs) {
|
|
33
|
+
const name = inputs.project ??
|
|
34
|
+
(await deps.prompter.textInput({
|
|
35
|
+
message: COPY.CONNECT.projectNameMessage,
|
|
36
|
+
defaultValue: defaultProjectName(deps.context.cwd),
|
|
37
|
+
validate: validateProjectName,
|
|
38
|
+
}));
|
|
39
|
+
return name.trim();
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Read-only probe: list one project. Only the credential matters here — an
|
|
43
|
+
* instance with no projects yet still answers 200.
|
|
44
|
+
*/
|
|
45
|
+
async function checkApiKey(deps, endpoint, apiKey) {
|
|
46
|
+
const client = deps.createClient({ endpoint, apiKey });
|
|
47
|
+
try {
|
|
48
|
+
await client.GET("/v1/projects", {
|
|
49
|
+
params: { query: { limit: 1 } },
|
|
50
|
+
signal: AbortSignal.timeout(REST_TIMEOUT_MS),
|
|
51
|
+
});
|
|
52
|
+
return { kind: "ok" };
|
|
53
|
+
}
|
|
54
|
+
catch (error) {
|
|
55
|
+
if (error instanceof HttpError) {
|
|
56
|
+
if (error.status === 401 || error.status === 403) {
|
|
57
|
+
return { kind: "rejected", status: error.status };
|
|
58
|
+
}
|
|
59
|
+
return { kind: "error", detail: `HTTP ${error.status}` };
|
|
60
|
+
}
|
|
61
|
+
return { kind: "error", detail: redactForDisplay(String(error)) };
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
// ---------------------------------------------------------------------------
|
|
65
|
+
// Interactive lanes
|
|
66
|
+
// ---------------------------------------------------------------------------
|
|
67
|
+
async function connectAuthOff(deps, endpoint, inputs) {
|
|
68
|
+
const projectName = await promptForProjectName(deps, inputs);
|
|
69
|
+
deps.prompter.line(COPY.CONNECT.usingProject(projectName));
|
|
70
|
+
return { endpoint, projectName };
|
|
71
|
+
}
|
|
72
|
+
/** Prompt for an API key without echoing it to the terminal. */
|
|
73
|
+
async function promptForApiKey(deps) {
|
|
74
|
+
const apiKey = await deps.prompter.passwordInput({
|
|
75
|
+
message: COPY.API_KEY.pasteKeyMessage,
|
|
76
|
+
validate: (value) => value.trim() ? undefined : COPY.API_KEY.pasteKeyInvalid,
|
|
77
|
+
});
|
|
78
|
+
return apiKey.trim();
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* A rejected key returns to the masked credential prompt without asking for
|
|
82
|
+
* the project name again.
|
|
83
|
+
*/
|
|
84
|
+
async function connectAuthOnInteractive(deps, endpoint, inputs) {
|
|
85
|
+
deps.prompter.note(COPY.API_KEY.instructions, COPY.API_KEY.instructionsTitle);
|
|
86
|
+
let apiKey = await promptForApiKey(deps);
|
|
87
|
+
const projectName = await promptForProjectName(deps, inputs);
|
|
88
|
+
for (;;) {
|
|
89
|
+
const result = await checkApiKey(deps, endpoint, apiKey);
|
|
90
|
+
if (result.kind === "ok") {
|
|
91
|
+
deps.prompter.line(COPY.CONNECT.usingProject(projectName));
|
|
92
|
+
return { endpoint, projectName, apiKey };
|
|
93
|
+
}
|
|
94
|
+
if (result.kind === "rejected") {
|
|
95
|
+
deps.prompter.line(COPY.API_KEY.pasteKeyRejected);
|
|
96
|
+
apiKey = await promptForApiKey(deps);
|
|
97
|
+
continue;
|
|
98
|
+
}
|
|
99
|
+
throw new SetupFatalError(COPY.CONNECT.connectFailed(result.detail));
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
// ---------------------------------------------------------------------------
|
|
103
|
+
// Headless lane
|
|
104
|
+
// ---------------------------------------------------------------------------
|
|
105
|
+
async function connectHeadless(deps, endpoint, authEnabled, inputs) {
|
|
106
|
+
if (!inputs.project) {
|
|
107
|
+
throw new HeadlessInputError(COPY.CONNECT.headlessNeedsProject);
|
|
108
|
+
}
|
|
109
|
+
const projectName = inputs.project.trim();
|
|
110
|
+
if (!authEnabled) {
|
|
111
|
+
return { endpoint, projectName };
|
|
112
|
+
}
|
|
113
|
+
const apiKey = inputs.apiKey;
|
|
114
|
+
if (!apiKey) {
|
|
115
|
+
throw new HeadlessInputError(COPY.CONNECT.headlessNeedsApiKey);
|
|
116
|
+
}
|
|
117
|
+
const result = await checkApiKey(deps, endpoint, apiKey);
|
|
118
|
+
if (result.kind === "rejected") {
|
|
119
|
+
throw new SetupFatalError(COPY.CONNECT.headlessAuthRejected);
|
|
120
|
+
}
|
|
121
|
+
if (result.kind === "error") {
|
|
122
|
+
throw new SetupFatalError(COPY.CONNECT.connectFailed(result.detail));
|
|
123
|
+
}
|
|
124
|
+
return { endpoint, projectName, apiKey };
|
|
125
|
+
}
|
|
126
|
+
export async function establishConnection(deps, { endpoint, authEnabled, inputs }) {
|
|
127
|
+
// A --project / env-provided name bypasses the prompt in every lane, so
|
|
128
|
+
// enforce here the same rule the prompt validates interactively.
|
|
129
|
+
if (inputs.project !== undefined) {
|
|
130
|
+
const nameError = validateProjectName(inputs.project);
|
|
131
|
+
if (nameError) {
|
|
132
|
+
throw new HeadlessInputError(nameError);
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
if (inputs.headless) {
|
|
136
|
+
return connectHeadless(deps, endpoint, authEnabled, inputs);
|
|
137
|
+
}
|
|
138
|
+
if (!authEnabled) {
|
|
139
|
+
return connectAuthOff(deps, endpoint, inputs);
|
|
140
|
+
}
|
|
141
|
+
return connectAuthOnInteractive(deps, endpoint, inputs);
|
|
142
|
+
}
|
|
143
|
+
//# sourceMappingURL=establishConnection.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"establishConnection.js","sourceRoot":"","sources":["../../../src/setup/steps/establishConnection.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAEhE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAUlD,MAAM,eAAe,GAAG,MAAM,CAAC;AAE/B,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,yEAAyE;AACzE,MAAM,UAAU,mBAAmB,CAAC,KAAa;IAC/C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;IACzC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,GAAW;IAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9D,OAAO,IAAI,IAAI,SAAS,CAAC;AAC3B,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,IAA6C,EAC7C,MAAmB;IAEnB,MAAM,IAAI,GACR,MAAM,CAAC,OAAO;QACd,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB;YACxC,YAAY,EAAE,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;YAClD,QAAQ,EAAE,mBAAmB;SAC9B,CAAC,CAAC,CAAC;IACN,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC;AAWD;;;GAGG;AACH,KAAK,UAAU,WAAW,CACxB,IAAqC,EACrC,QAAgB,EAChB,MAAc;IAEd,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IACvD,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE;YAC/B,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;YAC/B,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC;SAC7C,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACjD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;YACpD,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3D,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;IACpE,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E,KAAK,UAAU,cAAc,CAC3B,IAA6C,EAC7C,QAAgB,EAChB,MAAmB;IAEnB,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;IAC3D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACnC,CAAC;AAED,gEAAgE;AAChE,KAAK,UAAU,eAAe,CAC5B,IAAiC;IAEjC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;QAC/C,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;QACrC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAClB,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe;KAC1D,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,wBAAwB,CACrC,IAA8D,EAC9D,QAAgB,EAChB,MAAmB;IAEnB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC9E,IAAI,MAAM,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAE7D,SAAS,CAAC;QACR,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACzD,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;YAC3D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;QAC3C,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YAClD,MAAM,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;YACrC,SAAS;QACX,CAAC;QACD,MAAM,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACvE,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,gBAAgB;AAChB,8EAA8E;AAE9E,KAAK,UAAU,eAAe,CAC5B,IAAqC,EACrC,QAAgB,EAChB,WAAoB,EACpB,MAAmB;IAEnB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAClE,CAAC;IACD,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAE1C,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;IACnC,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjE,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzD,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,MAAM,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;AAC3C,CAAC;AAYD,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,IAA8D,EAC9D,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAA2B;IAE1D,wEAAwE;IACxE,iEAAiE;IACjE,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtD,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,OAAO,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,wBAAwB,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAC1D,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Install the tooling: the global `px` CLI, and the Phoenix skills.
|
|
3
|
+
*
|
|
4
|
+
* Runs after traces are verified — the peak-motivation moment — and offers
|
|
5
|
+
* the tooling that turns "traces are flowing" into "I can look at them":
|
|
6
|
+
* a global `px` install when setup is running without `px` on PATH
|
|
7
|
+
* (the `npx @arizeai/phoenix-cli setup` case), and the Phoenix skills for
|
|
8
|
+
* the user's coding agent via `npx skills add` (no `--skill` pins — the
|
|
9
|
+
* skills CLI's own picker lists the repo's skills and target agents). Both
|
|
10
|
+
* installs are spawned on the terminal so their own output and prompts show
|
|
11
|
+
* through; failures are non-fatal warnings with the command to retry by hand.
|
|
12
|
+
*/
|
|
13
|
+
import type { SetupDeps } from "../deps/index.js";
|
|
14
|
+
/** What an install offer did — reported in the setup summary. */
|
|
15
|
+
export type ToolingOutcome = "installed" | "failed" | "declined" | "skipped";
|
|
16
|
+
export interface ToolingResult {
|
|
17
|
+
cli: ToolingOutcome;
|
|
18
|
+
skills: ToolingOutcome;
|
|
19
|
+
}
|
|
20
|
+
export declare function offerToolingInstalls(deps: Pick<SetupDeps, "context" | "processes" | "prompter">, { pxOnPath, skills, canPrompt, }: {
|
|
21
|
+
/** Started at setup launch so the probe never blocks this prompt. */
|
|
22
|
+
pxOnPath: Promise<boolean>;
|
|
23
|
+
/** `--skills` / `--no-skills`; undefined means ask (when we can). */
|
|
24
|
+
skills?: boolean;
|
|
25
|
+
/** False in a headless run: there is no terminal to ask on. */
|
|
26
|
+
canPrompt: boolean;
|
|
27
|
+
}): Promise<ToolingResult>;
|
|
28
|
+
//# sourceMappingURL=installTooling.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"installTooling.d.ts","sourceRoot":"","sources":["../../../src/setup/steps/installTooling.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,KAAK,EAAe,SAAS,EAAE,MAAM,SAAS,CAAC;AAiCtD,iEAAiE;AACjE,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;AAE7E,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,cAAc,CAAC;IACpB,MAAM,EAAE,cAAc,CAAC;CACxB;AAiCD,wBAAsB,oBAAoB,CACxC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,CAAC,EAC3D,EACE,QAAQ,EACR,MAAM,EACN,SAAS,GACV,EAAE;IACD,qEAAqE;IACrE,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B,qEAAqE;IACrE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,+DAA+D;IAC/D,SAAS,EAAE,OAAO,CAAC;CACpB,GACA,OAAO,CAAC,aAAa,CAAC,CAoBxB"}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Install the tooling: the global `px` CLI, and the Phoenix skills.
|
|
3
|
+
*
|
|
4
|
+
* Runs after traces are verified — the peak-motivation moment — and offers
|
|
5
|
+
* the tooling that turns "traces are flowing" into "I can look at them":
|
|
6
|
+
* a global `px` install when setup is running without `px` on PATH
|
|
7
|
+
* (the `npx @arizeai/phoenix-cli setup` case), and the Phoenix skills for
|
|
8
|
+
* the user's coding agent via `npx skills add` (no `--skill` pins — the
|
|
9
|
+
* skills CLI's own picker lists the repo's skills and target agents). Both
|
|
10
|
+
* installs are spawned on the terminal so their own output and prompts show
|
|
11
|
+
* through; failures are non-fatal warnings with the command to retry by hand.
|
|
12
|
+
*/
|
|
13
|
+
import * as COPY from "../copy.js";
|
|
14
|
+
import { selectBoolean } from "../ui/selectBoolean.js";
|
|
15
|
+
const CLI_INSTALL_SPEC = {
|
|
16
|
+
command: "npm",
|
|
17
|
+
args: ["install", "-g", "@arizeai/phoenix-cli"],
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* `npx skills add`, as spawned. The leading `-y` is npx's own — install the
|
|
21
|
+
* `skills` package without asking.
|
|
22
|
+
*
|
|
23
|
+
* Unattended, the skills CLI needs its `--yes` too: it is interactive by
|
|
24
|
+
* default (a skill picker, an agent picker, a final confirm) and a missing TTY
|
|
25
|
+
* does not suppress those prompts, so without the flag a headless run hangs on
|
|
26
|
+
* stdin. With it, the installer takes every skill in the repo for the agents it
|
|
27
|
+
* detects. Interactively we leave it off, so the user drives those pickers.
|
|
28
|
+
*/
|
|
29
|
+
function skillsAddSpec(unattended) {
|
|
30
|
+
return {
|
|
31
|
+
command: "npx",
|
|
32
|
+
args: [
|
|
33
|
+
"-y",
|
|
34
|
+
"skills",
|
|
35
|
+
"add",
|
|
36
|
+
COPY.SKILLS_SOURCE,
|
|
37
|
+
...(unattended ? ["--yes"] : []),
|
|
38
|
+
],
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Install, honoring a decision the caller already made. `decided` short-circuits
|
|
43
|
+
* the prompt: `true` installs (`--skills`), `false` skips (`--no-skills`), and
|
|
44
|
+
* `undefined` asks — so a headless run, which has no terminal to ask on, must
|
|
45
|
+
* arrive here already decided.
|
|
46
|
+
*/
|
|
47
|
+
async function offerInstall(deps, copy, spec, decided) {
|
|
48
|
+
const optedIn = decided ??
|
|
49
|
+
(await selectBoolean({
|
|
50
|
+
prompter: deps.prompter,
|
|
51
|
+
message: copy.message,
|
|
52
|
+
yesLabel: copy.yes,
|
|
53
|
+
noLabel: copy.no,
|
|
54
|
+
}));
|
|
55
|
+
if (!optedIn) {
|
|
56
|
+
return "declined";
|
|
57
|
+
}
|
|
58
|
+
const { exitCode } = await deps.processes.spawnInteractive({
|
|
59
|
+
...spec,
|
|
60
|
+
cwd: deps.context.cwd,
|
|
61
|
+
});
|
|
62
|
+
deps.prompter.line(exitCode === 0 ? copy.installed : copy.failed);
|
|
63
|
+
return exitCode === 0 ? "installed" : "failed";
|
|
64
|
+
}
|
|
65
|
+
export async function offerToolingInstalls(deps, { pxOnPath, skills, canPrompt, }) {
|
|
66
|
+
// The global CLI install is prompt-only — it is offered when `px` is missing
|
|
67
|
+
// (an `npx` run), and skipped outright when we cannot ask, because installing
|
|
68
|
+
// a global npm package is not something to do to an unattended caller.
|
|
69
|
+
const cli = !canPrompt || (await pxOnPath)
|
|
70
|
+
? "skipped"
|
|
71
|
+
: await offerInstall(deps, COPY.TOOLING.cli, CLI_INSTALL_SPEC);
|
|
72
|
+
// With no prompt to fall back on, an unflagged skills install defaults to
|
|
73
|
+
// going ahead: the only reason to invoke this lane unattended is to install.
|
|
74
|
+
// `--no-skills` still declines. This default lives here, next to `canPrompt`,
|
|
75
|
+
// rather than in each caller.
|
|
76
|
+
const skillsOutcome = await offerInstall(deps, COPY.TOOLING.skills, skillsAddSpec(!canPrompt), canPrompt ? skills : (skills ?? true));
|
|
77
|
+
return { cli, skills: skillsOutcome };
|
|
78
|
+
}
|
|
79
|
+
//# sourceMappingURL=installTooling.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"installTooling.js","sourceRoot":"","sources":["../../../src/setup/steps/installTooling.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,gBAAgB,GAA6B;IACjD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,sBAAsB,CAAC;CAChD,CAAC;AAEF;;;;;;;;;GASG;AACH,SAAS,aAAa,CAAC,UAAmB;IACxC,OAAO;QACL,OAAO,EAAE,KAAK;QACd,IAAI,EAAE;YACJ,IAAI;YACJ,QAAQ;YACR,KAAK;YACL,IAAI,CAAC,aAAa;YAClB,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACjC;KACF,CAAC;AACJ,CAAC;AAYD;;;;;GAKG;AACH,KAAK,UAAU,YAAY,CACzB,IAA2D,EAC3D,IAAsB,EACtB,IAA8B,EAC9B,OAAiB;IAEjB,MAAM,OAAO,GACX,OAAO;QACP,CAAC,MAAM,aAAa,CAAC;YACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,GAAG;YAClB,OAAO,EAAE,IAAI,CAAC,EAAE;SACjB,CAAC,CAAC,CAAC;IACN,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC;QACzD,GAAG,IAAI;QACP,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;KACtB,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClE,OAAO,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC;AACjD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,IAA2D,EAC3D,EACE,QAAQ,EACR,MAAM,EACN,SAAS,GAQV;IAED,6EAA6E;IAC7E,8EAA8E;IAC9E,uEAAuE;IACvE,MAAM,GAAG,GACP,CAAC,SAAS,IAAI,CAAC,MAAM,QAAQ,CAAC;QAC5B,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,MAAM,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;IAEnE,0EAA0E;IAC1E,6EAA6E;IAC7E,8EAA8E;IAC9E,8BAA8B;IAC9B,MAAM,aAAa,GAAG,MAAM,YAAY,CACtC,IAAI,EACJ,IAAI,CAAC,OAAO,CAAC,MAAM,EACnB,aAAa,CAAC,CAAC,SAAS,CAAC,EACzB,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,CACtC,CAAC;IACF,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AACxC,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Instrumentation hand-off.
|
|
3
|
+
*
|
|
4
|
+
* Lanes, in order of preference: launch a detected coding agent directly
|
|
5
|
+
* (prompt pre-loaded, credentials injected via env), copy the prompt for an
|
|
6
|
+
* agent the user runs themselves, or manual via the quickstart docs. All
|
|
7
|
+
* lanes converge on the trace-verification step — setup's definition of
|
|
8
|
+
* done is API-verified data flow, not agent self-report.
|
|
9
|
+
*
|
|
10
|
+
* `--agent` pre-answers the lane, which is what makes an unattended run
|
|
11
|
+
* possible: with no TTY there is no prompt to pick a lane from, and the agent
|
|
12
|
+
* runs in background mode (no TUI to hand the terminal to).
|
|
13
|
+
*/
|
|
14
|
+
import { type AgentRunMode, type CodingAgent, type CodingAgentId } from "../agents/registry.js";
|
|
15
|
+
import type { DocsPrefetchResult, SetupDeps } from "../deps/index.js";
|
|
16
|
+
import type { Connection } from "./establishConnection.js";
|
|
17
|
+
export interface InstrumentAppArgs {
|
|
18
|
+
authEnabled: boolean;
|
|
19
|
+
/** Started at setup launch so the probes never block this prompt. */
|
|
20
|
+
agentDetection: Promise<CodingAgent[]>;
|
|
21
|
+
/** `--agent`: skip the lane prompt and launch this agent. */
|
|
22
|
+
agent?: CodingAgentId;
|
|
23
|
+
/** `--language`: passed through so the agent skips its own detection. */
|
|
24
|
+
languages: string[];
|
|
25
|
+
/** How to run the agent — see {@link AgentRunMode}. */
|
|
26
|
+
mode: AgentRunMode;
|
|
27
|
+
/** Where the prefetched docs landed, when the docs step ran. */
|
|
28
|
+
docs?: DocsPrefetchResult;
|
|
29
|
+
}
|
|
30
|
+
/** Which lane instrumentation actually took — reported in the summary. */
|
|
31
|
+
export type InstrumentationLane = {
|
|
32
|
+
kind: "agent";
|
|
33
|
+
agent: CodingAgentId;
|
|
34
|
+
exitCode: number;
|
|
35
|
+
} | {
|
|
36
|
+
kind: "clipboard";
|
|
37
|
+
} | {
|
|
38
|
+
kind: "manual";
|
|
39
|
+
};
|
|
40
|
+
export declare function instrumentApp(deps: Pick<SetupDeps, "context" | "processes" | "prompter" | "writeClipboard">, connection: Connection, args: InstrumentAppArgs): Promise<InstrumentationLane>;
|
|
41
|
+
//# sourceMappingURL=instrumentApp.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"instrumentApp.d.ts","sourceRoot":"","sources":["../../../src/setup/steps/instrumentApp.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAIL,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,aAAa,EACnB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAAE,kBAAkB,EAAgB,SAAS,EAAE,MAAM,SAAS,CAAC;AAG3E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAQxD,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,OAAO,CAAC;IACrB,qEAAqE;IACrE,cAAc,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IACvC,6DAA6D;IAC7D,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,yEAAyE;IACzE,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,uDAAuD;IACvD,IAAI,EAAE,YAAY,CAAC;IACnB,gEAAgE;IAChE,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED,0EAA0E;AAC1E,MAAM,MAAM,mBAAmB,GAC3B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,aAAa,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AAEvB,wBAAsB,aAAa,CACjC,IAAI,EAAE,IAAI,CACR,SAAS,EACT,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,gBAAgB,CACxD,EACD,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,mBAAmB,CAAC,CAgG9B"}
|