Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

fix(open-knowledge): ok seed --dry-run previews without ok init (#2305)

tim-inkeep17cd8adb5175
diff --git a/.changeset/seed-dry-run-preview.md b/.changeset/seed-dry-run-preview.md
new file mode 100644
index 000000000..edccc5c1e
--- /dev/null
+++ b/.changeset/seed-dry-run-preview.md
@@ -0,0 +1,6 @@
+---
+"@inkeep/open-knowledge-server": patch
+"@inkeep/open-knowledge": patch
+---
+
+`ok seed --dry-run` now previews a pack in an uninitialized directory instead of erroring with "Run `ok init` first". The prerequisite gate is skipped for dry-runs (whose purpose is to preview a pack before adopting it); real seeding still requires an initialized project.
diff --git a/packages/cli/src/commands/seed.test.ts b/packages/cli/src/commands/seed.test.ts
index 45a501999..5e0995783 100644
--- a/packages/cli/src/commands/seed.test.ts
+++ b/packages/cli/src/commands/seed.test.ts
@@ -93,6 +93,24 @@ describe('runSeed — --dry-run', () => {
expect(existsSync(join(testDir, folder.path))).toBe(false);
}
});
+
+ test('previews in an uninitialized dir without requiring `ok init`', async () => {
+ const result = await runSeed({ cwd: testDir, pack: 'knowledge-base', dryRun: true });
+ expect(result.status).toBe('dry-run');
+ expect(result.exitCode).toBe(0);
+ for (const folder of STARTER_FOLDERS) {
+ expect(existsSync(join(testDir, folder.path))).toBe(false);
+ }
+ expect(existsSync(join(testDir, OK_DIR, CONFIG_FILENAME))).toBe(false);
+ });
+
+ test('returns no-op (not dry-run) when the directory is already fully seeded', async () => {
+ scaffoldOkDir(testDir);
+ await runSeed({ cwd: testDir, yes: true });
+ const result = await runSeed({ cwd: testDir, dryRun: true });
+ expect(result.status).toBe('no-op');
+ expect(result.exitCode).toBe(0);
+ });
});
describe('runSeed — no-op', () => {
diff --git a/packages/cli/src/commands/seed.ts b/packages/cli/src/commands/seed.ts
index 13420d27c..2143a0adf 100644
--- a/packages/cli/src/commands/seed.ts
+++ b/packages/cli/src/commands/seed.ts
@@ -48,7 +48,12 @@ export async function runSeed(opts: SeedCommandOptions = {}): Promise<SeedComman
let plan: ScaffoldPlan;
try {
- plan = await planSeed({ projectDir: cwd, rootDir: opts.root, packId });
+ plan = await planSeed({
+ projectDir: cwd,
+ rootDir: opts.root,
+ packId,
+ skipPrerequisite: opts.dryRun === true,
+ });
} catch (err) {
if (err instanceof SeedPrerequisiteError) {
return {
diff --git a/packages/server/src/seed/plan.test.ts b/packages/server/src/seed/plan.test.ts
index febaa97bf..a00199540 100644
--- a/packages/server/src/seed/plan.test.ts
+++ b/packages/server/src/seed/plan.test.ts
@@ -42,6 +42,17 @@ describe('planSeed — nested .ok/ era', () => {
}
});
+ test('skipPrerequisite bypasses the gate — previews an all-created plan in a bare dir', async () => {
+ const bare = await mkdtemp(join(tmpdir(), 'seed-preview-'));
+ try {
+ const plan = await planSeed({ projectDir: bare, skipPrerequisite: true });
+ expect(plan.created.length).toBeGreaterThan(0);
+ expect(plan.skipped.length).toBe(0);
+ } finally {
+ await rm(bare, { recursive: true, force: true });
+ }
+ });
+
test('plans every starter folder + nested .ok/ + frontmatter.yml + templates/<name>.md', async () => {
const plan = await planSeed({ projectDir });
const createdPaths = new Set(plan.created.map((e) => e.path));
diff --git a/packages/server/src/seed/plan.ts b/packages/server/src/seed/plan.ts
index 5dc925b58..1618dcbd8 100644
--- a/packages/server/src/seed/plan.ts
+++ b/packages/server/src/seed/plan.ts
@@ -40,7 +40,7 @@ function joinRelative(root: string, path: string): string {
export async function planSeed(opts: SeedOptions = {}): Promise<ScaffoldPlan> {
const projectDir = resolve(opts.projectDir ?? process.cwd());
- if (!isProjectRoot(projectDir)) {
+ if (!opts.skipPrerequisite && !isProjectRoot(projectDir)) {
throw new SeedPrerequisiteError(
`No ${OK_PROJECT_MARKER} found at ${projectDir}. Run \`ok init\` first to scaffold the tool config.`,
);
diff --git a/packages/server/src/seed/types.ts b/packages/server/src/seed/types.ts
index b4ef82454..358c87b57 100644
--- a/packages/server/src/seed/types.ts
+++ b/packages/server/src/seed/types.ts
@@ -35,6 +35,7 @@ export interface SeedOptions {
projectDir?: string;
rootDir?: string;
packId?: PackId;
+ skipPrerequisite?: boolean;
}
export class SeedPrerequisiteError extends Error {