create-cogitator-app 0.7.1 → 0.8.1

package/dist/lib.d.ts

@@ -160,6 +160,10 @@ interface SetupState {
     keyWritten: boolean;
     /** Whether the Ollama model is known to be pulled. */
     modelReady: boolean;
+    /** Whether the compose services were started already. */
+    servicesStarted?: boolean;
+    /** Whether the Ollama container compose started is pulling the model. */
+    modelPulling?: boolean;
 }
 
 interface PlanOptions {
@@ -178,6 +182,8 @@ interface ProjectPlan {
     env: EnvVar[];
     /** Compose services the project starts locally. */
     services: string[];
+    /** The services among them that run a task and exit, such as pulling the Ollama models. */
+    oneShotServices: string[];
     warnings: string[];
     /** The command that creates this project again. */
     command: string;
@@ -528,6 +534,35 @@ declare function createFromTemplate(template: RemoteTemplate, options: StarterOp
     token?: string;
 }): Promise<StarterResult>;
 
+/**
+ * Whether Docker can start the project's services: the compose plugin is
+ * installed and the daemon answers. Never throws.
+ */
+declare function dockerComposeAvailable(cwd: string): Promise<boolean>;
+/**
+ * Starts the compose services of a scaffolded project in `directory` and
+ * waits until the long-running ones are healthy, or running when they have no
+ * healthcheck. One-shot services, such as the one that pulls the Ollama
+ * models, start afterwards without waiting, since `--wait` is not meant for
+ * containers that exit. Resolves with how it went and never throws.
+ */
+declare function startServices(directory: string, plan: Pick<ProjectPlan, 'services' | 'oneShotServices'>): Promise<StepResult>;
+
+type ComposeServices = Pick<ProjectPlan, 'services' | 'oneShotServices'>;
+/**
+ * The services to start: all of them, but the Ollama ones when an Ollama
+ * already answers where the project looks for it. The project uses that one,
+ * and a second one in compose could not bind its port anyway.
+ */
+declare function servicesToStart(plan: ComposeServices, ollamaUrl?: string): Promise<ComposeServices>;
+/**
+ * Offers to start the project's compose services when it has some and Docker
+ * is ready, and starts them on a yes. Only for an interactive run: the caller
+ * never asks in CI, with `--yes`, `--json` or without a TTY. Resolves with
+ * whether they were started.
+ */
+declare function offerServices(directory: string, plan: ComposeServices): Promise<boolean>;
+
 /** A combination the generated project could not work with, and how to fix it. */
 interface CompatIssue {
     message: string;
@@ -669,8 +704,10 @@ interface OllamaModel {
     size: number;
 }
 /**
- * The Ollama server the generated code talks to: `OLLAMA_BASE_URL`, which it
- * reads, then `OLLAMA_HOST`, which the Ollama CLI reads, then the local default.
+ * The Ollama server the generated project talks to: `OLLAMA_BASE_URL`, which
+ * its `cogitator.yml` reads, else the local default. `OLLAMA_HOST` is where
+ * the Ollama server listens, often `0.0.0.0`, and the project never reads it.
+ * A bare host gets port 11434, the way Ollama reads its own address.
  */
 declare function resolveOllamaUrl(env?: Record<string, string | undefined>): string;
 /** The models installed in the Ollama at `baseUrl`, or `undefined` when it does not answer. */
@@ -730,6 +767,8 @@ declare const VERSIONS: {
     readonly typesNode: "^24.19.1";
     readonly tsx: "^4.23.15";
     readonly vitest: "^5.0.3";
+    /** A peer vitest requires and Yarn, unlike npm, pnpm and Bun, does not install by itself. */
+    readonly vite: "^8.3.4";
     readonly biome: "^2.5.15";
     readonly express: "^5.2.1";
     readonly typesExpress: "^5.0.6";
@@ -884,6 +923,10 @@ interface Io {
 interface RunDeps {
     fetch?: typeof fetch;
     env?: NodeJS.ProcessEnv;
+    /** The terminal input, which decides with `env` whether anything is asked. */
+    stdin?: {
+        isTTY?: boolean;
+    };
     /** Where telemetry goes, the release's Umami website by default. */
     telemetry?: {
         websiteId?: string;
@@ -897,4 +940,41 @@ declare function run(argv: readonly string[], io?: Io, deps?: RunDeps): Promise<
 /** The candidate closest to `input`, when it is close enough to be a typo of it. */
 declare function closest(input: string, candidates: readonly string[]): string | undefined;
 
-export { APP_CHOICES, APP_KINDS, type AddChanges, type AddConflict, AddConflictError, type AddNote, type AddOptions, type AddPlan, type AddResult, type AppKind, CHANNELS, CHANNEL_CHOICES, CODING_AGENTS, CODING_AGENT_CHOICES, type ChannelKind, type Choice, CodedError, type CodingAgent, type CompatIssue, DEFAULT_OLLAMA_URL, DEFAULT_PRESET, DEPLOY_CHOICES, DEPLOY_TARGETS, type DeployTarget, type DownloadResult, type ExampleEntry, type ExamplePlan, type ExamplePlanOptions, FEATURES, FEATURE_CHOICES, type FailedStep, type FeatureId, type FileChange, IMAGES, IncompatibleSpecError, type KeyCheck, type LLMProvider, LOCK_PATH, MANIFEST_KEY, MEMORIES, MEMORY_CHOICES, type MemoryKind, type ModelChoice, type ModelChoices, type ModelSource, NotAScaffoldedProjectError, OLLAMA_SUGGESTED_MODELS, type OllamaModel, PACKAGE_MANAGERS, PAYLOAD_FIELDS, PRESETS, PROVIDERS, PROVIDER_INFO, type PackageManager, type PlanOptions, type PreparedTemplate, type Preset, type ProjectPlan, type ProjectSpec, type ProjectSpecInput, ProjectSpecSchema, type ProviderInfo, type RemoteTemplate, SERVERS, SERVER_CHOICES, type ScaffoldFailure, type ScaffoldLock, type ScaffoldLogger, type ScaffoldManifest, type ScaffoldOptions, type ScaffoldResult, type ServerFramework, type StarterOptions, type StarterResult, type StepResult, TELEMETRY_DOCS, TELEMETRY_HOST, type TelemetryPayload, VECTOR_STORES, VECTOR_STORE_CHOICES, VERSIONS, type VectorStore, addToProject, assertCompatible, bareModel, changesDependencies, checkApiKey, closest, cloudModelChoices, cogitatorVersion, compatibilityIssues, createFromExample, createFromTemplate, defaultModel, describeKeyCheck, describeModel, describeTemplate, detectPackageManager, detectPackageManagerSpec, downloadTemplate, exampleFileUrl, exampleRef, examples, execCommand, fetchExampleFiles, findExample, findPreset, firstRunNotice, formatProject, hasOllamaModel, hashContent, installCommand, installErrorCode, installFailure, knownCogitatorVersions, listOllamaModels, modelChoices, ollamaModelChoices, parseExampleArgument, parseSpec, payloadFor, planAdd, planExample, planProject, prepareTemplate, presetIds, providerEnvKey, providerInfo, pullOllamaModel, qualifiedModel, readLock, resolveExample, resolveOllamaUrl, run, runScript, scaffold, scaffolderVersion, sendTelemetry, silentLogger, telemetryDisabledReason, telemetryErrorCode, telemetryWebsiteId, templateArchive, unifiedDiff, updateLock, validateProjectName, writeFiles, writeLock };
+interface CliArgs {
+    directory?: string;
+    preset?: string;
+    remote?: RemoteTemplate;
+    example?: string;
+    app?: AppKind;
+    server?: ServerFramework;
+    channels?: ChannelKind[];
+    memory?: MemoryKind;
+    vectorStore?: VectorStore;
+    features?: FeatureId[];
+    deploy?: DeployTarget;
+    compose?: boolean;
+    provider?: LLMProvider;
+    model?: string;
+    apiKey?: string;
+    packageManager?: PackageManager;
+    codingAgents?: CodingAgent[];
+    git?: boolean;
+    install?: boolean;
+    telemetry?: boolean;
+    yes: boolean;
+    dryRun: boolean;
+    json: boolean;
+    help: boolean;
+    version: boolean;
+    listTemplates: boolean;
+    listExamples: boolean;
+}
+/**
+ * Whether to ask questions: only at a terminal, and never with `--yes`,
+ * `--json` or in CI, where nobody can answer.
+ */
+declare function isInteractive(args: Pick<CliArgs, 'yes' | 'json'>, env?: NodeJS.ProcessEnv, stdin?: {
+    isTTY?: boolean;
+}): boolean;
+
+export { APP_CHOICES, APP_KINDS, type AddChanges, type AddConflict, AddConflictError, type AddNote, type AddOptions, type AddPlan, type AddResult, type AppKind, CHANNELS, CHANNEL_CHOICES, CODING_AGENTS, CODING_AGENT_CHOICES, type ChannelKind, type Choice, CodedError, type CodingAgent, type CompatIssue, DEFAULT_OLLAMA_URL, DEFAULT_PRESET, DEPLOY_CHOICES, DEPLOY_TARGETS, type DeployTarget, type DownloadResult, type ExampleEntry, type ExamplePlan, type ExamplePlanOptions, FEATURES, FEATURE_CHOICES, type FailedStep, type FeatureId, type FileChange, IMAGES, IncompatibleSpecError, type KeyCheck, type LLMProvider, LOCK_PATH, MANIFEST_KEY, MEMORIES, MEMORY_CHOICES, type MemoryKind, type ModelChoice, type ModelChoices, type ModelSource, NotAScaffoldedProjectError, OLLAMA_SUGGESTED_MODELS, type OllamaModel, PACKAGE_MANAGERS, PAYLOAD_FIELDS, PRESETS, PROVIDERS, PROVIDER_INFO, type PackageManager, type PlanOptions, type PreparedTemplate, type Preset, type ProjectPlan, type ProjectSpec, type ProjectSpecInput, ProjectSpecSchema, type ProviderInfo, type RemoteTemplate, SERVERS, SERVER_CHOICES, type ScaffoldFailure, type ScaffoldLock, type ScaffoldLogger, type ScaffoldManifest, type ScaffoldOptions, type ScaffoldResult, type ServerFramework, type StarterOptions, type StarterResult, type StepResult, TELEMETRY_DOCS, TELEMETRY_HOST, type TelemetryPayload, VECTOR_STORES, VECTOR_STORE_CHOICES, VERSIONS, type VectorStore, addToProject, assertCompatible, bareModel, changesDependencies, checkApiKey, closest, cloudModelChoices, cogitatorVersion, compatibilityIssues, createFromExample, createFromTemplate, defaultModel, describeKeyCheck, describeModel, describeTemplate, detectPackageManager, detectPackageManagerSpec, dockerComposeAvailable, downloadTemplate, exampleFileUrl, exampleRef, examples, execCommand, fetchExampleFiles, findExample, findPreset, firstRunNotice, formatProject, hasOllamaModel, hashContent, installCommand, installErrorCode, installFailure, isInteractive, knownCogitatorVersions, listOllamaModels, modelChoices, offerServices, ollamaModelChoices, parseExampleArgument, parseSpec, payloadFor, planAdd, planExample, planProject, prepareTemplate, presetIds, providerEnvKey, providerInfo, pullOllamaModel, qualifiedModel, readLock, resolveExample, resolveOllamaUrl, run, runScript, scaffold, scaffolderVersion, sendTelemetry, servicesToStart, silentLogger, startServices, telemetryDisabledReason, telemetryErrorCode, telemetryWebsiteId, templateArchive, unifiedDiff, updateLock, validateProjectName, writeFiles, writeLock };