@kinotic-ai/kinotic-cli 2.2.0 → 3.0.0

package/README.md

@@ -1,4 +1,4 @@
-Structures CLI
+Kinotic CLI
 =================
 
 <!-- toc -->
@@ -21,57 +21,13 @@ USAGE
 <!-- usagestop -->
 # Commands
 <!-- commands -->
-* [`kinotic autocomplete [SHELL]`](#kinotic-autocomplete-shell)
 * [`kinotic create project NAME`](#kinotic-create-project-name)
 * [`kinotic gen`](#kinotic-gen)
 * [`kinotic generate`](#kinotic-generate)
-* [`kinotic help [COMMAND]`](#kinotic-help-command)
 * [`kinotic init`](#kinotic-init)
 * [`kinotic initialize`](#kinotic-initialize)
-* [`kinotic plugins`](#kinotic-plugins)
-* [`kinotic plugins add PLUGIN`](#kinotic-plugins-add-plugin)
-* [`kinotic plugins:inspect PLUGIN...`](#kinotic-pluginsinspect-plugin)
-* [`kinotic plugins install PLUGIN`](#kinotic-plugins-install-plugin)
-* [`kinotic plugins link PATH`](#kinotic-plugins-link-path)
-* [`kinotic plugins remove [PLUGIN]`](#kinotic-plugins-remove-plugin)
-* [`kinotic plugins reset`](#kinotic-plugins-reset)
-* [`kinotic plugins uninstall [PLUGIN]`](#kinotic-plugins-uninstall-plugin)
-* [`kinotic plugins unlink [PLUGIN]`](#kinotic-plugins-unlink-plugin)
-* [`kinotic plugins update`](#kinotic-plugins-update)
 * [`kinotic sync`](#kinotic-sync)
 * [`kinotic synchronize`](#kinotic-synchronize)
-* [`kinotic update [CHANNEL]`](#kinotic-update-channel)
-
-## `kinotic autocomplete [SHELL]`
-
-Display autocomplete installation instructions.
-
-```
-USAGE
-  $ kinotic autocomplete [SHELL] [-r]
-
-ARGUMENTS
-  [SHELL]  (zsh|bash|powershell) Shell type
-
-FLAGS
-  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
-
-DESCRIPTION
-  Display autocomplete installation instructions.
-
-EXAMPLES
-  $ kinotic autocomplete
-
-  $ kinotic autocomplete bash
-
-  $ kinotic autocomplete zsh
-
-  $ kinotic autocomplete powershell
-
-  $ kinotic autocomplete --refresh-cache
-```
-
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.41/src/commands/autocomplete/index.ts)_
 
 ## `kinotic create project NAME`
 
@@ -151,26 +107,6 @@ EXAMPLES
 
 _See code: [src/commands/generate.ts](https://github.com/kinotic-ai/kinotic/blob/v2.2.0/src/commands/generate.ts)_
 
-## `kinotic help [COMMAND]`
-
-Display help for kinotic.
-
-```
-USAGE
-  $ kinotic help [COMMAND...] [-n]
-
-ARGUMENTS
-  [COMMAND...]  Command to show help for.
-
-FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
-
-DESCRIPTION
-  Display help for kinotic.
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.38/src/commands/help.ts)_
-
 ## `kinotic init`
 
 This will initialize a new Kinotic Project for use with the Kinotic CLI.
@@ -233,296 +169,6 @@ EXAMPLES
 
 _See code: [src/commands/initialize.ts](https://github.com/kinotic-ai/kinotic/blob/v2.2.0/src/commands/initialize.ts)_
 
-## `kinotic plugins`
-
-List installed plugins.
-
-```
-USAGE
-  $ kinotic plugins [--json] [--core]
-
-FLAGS
-  --core  Show core plugins.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  List installed plugins.
-
-EXAMPLES
-  $ kinotic plugins
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/index.ts)_
-
-## `kinotic plugins add PLUGIN`
-
-Installs a plugin into kinotic.
-
-```
-USAGE
-  $ kinotic plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
-
-ARGUMENTS
-  PLUGIN...  Plugin to install.
-
-FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Installs a plugin into kinotic.
-
-  Uses npm to install plugins.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  Use the KINOTIC_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the KINOTIC_NPM_REGISTRY environment variable to set the npm registry.
-
-ALIASES
-  $ kinotic plugins add
-
-EXAMPLES
-  Install a plugin from npm registry.
-
-    $ kinotic plugins add myplugin
-
-  Install a plugin from a github url.
-
-    $ kinotic plugins add https://github.com/someuser/someplugin
-
-  Install a plugin from a github slug.
-
-    $ kinotic plugins add someuser/someplugin
-```
-
-## `kinotic plugins:inspect PLUGIN...`
-
-Displays installation properties of a plugin.
-
-```
-USAGE
-  $ kinotic plugins inspect PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  [default: .] Plugin to inspect.
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Displays installation properties of a plugin.
-
-EXAMPLES
-  $ kinotic plugins inspect myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/inspect.ts)_
-
-## `kinotic plugins install PLUGIN`
-
-Installs a plugin into kinotic.
-
-```
-USAGE
-  $ kinotic plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
-
-ARGUMENTS
-  PLUGIN...  Plugin to install.
-
-FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Installs a plugin into kinotic.
-
-  Uses npm to install plugins.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  Use the KINOTIC_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the KINOTIC_NPM_REGISTRY environment variable to set the npm registry.
-
-ALIASES
-  $ kinotic plugins add
-
-EXAMPLES
-  Install a plugin from npm registry.
-
-    $ kinotic plugins install myplugin
-
-  Install a plugin from a github url.
-
-    $ kinotic plugins install https://github.com/someuser/someplugin
-
-  Install a plugin from a github slug.
-
-    $ kinotic plugins install someuser/someplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/install.ts)_
-
-## `kinotic plugins link PATH`
-
-Links a plugin into the CLI for development.
-
-```
-USAGE
-  $ kinotic plugins link PATH [-h] [--install] [-v]
-
-ARGUMENTS
-  PATH  [default: .] path to plugin
-
-FLAGS
-  -h, --help          Show CLI help.
-  -v, --verbose
-      --[no-]install  Install dependencies after linking the plugin.
-
-DESCRIPTION
-  Links a plugin into the CLI for development.
-
-  Installation of a linked plugin will override a user-installed or core plugin.
-
-  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
-  command will override the user-installed or core plugin implementation. This is useful for development work.
-
-
-EXAMPLES
-  $ kinotic plugins link myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/link.ts)_
-
-## `kinotic plugins remove [PLUGIN]`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ kinotic plugins remove [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  [PLUGIN...]  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ kinotic plugins unlink
-  $ kinotic plugins remove
-
-EXAMPLES
-  $ kinotic plugins remove myplugin
-```
-
-## `kinotic plugins reset`
-
-Remove all user-installed and linked plugins.
-
-```
-USAGE
-  $ kinotic plugins reset [--hard] [--reinstall]
-
-FLAGS
-  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
-  --reinstall  Reinstall all plugins after uninstalling.
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/reset.ts)_
-
-## `kinotic plugins uninstall [PLUGIN]`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ kinotic plugins uninstall [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  [PLUGIN...]  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ kinotic plugins unlink
-  $ kinotic plugins remove
-
-EXAMPLES
-  $ kinotic plugins uninstall myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/uninstall.ts)_
-
-## `kinotic plugins unlink [PLUGIN]`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ kinotic plugins unlink [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  [PLUGIN...]  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ kinotic plugins unlink
-  $ kinotic plugins remove
-
-EXAMPLES
-  $ kinotic plugins unlink myplugin
-```
-
-## `kinotic plugins update`
-
-Update installed plugins.
-
-```
-USAGE
-  $ kinotic plugins update [-h] [-v]
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Update installed plugins.
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/update.ts)_
-
 ## `kinotic sync`
 
 Synchronize the local Entity definitions with the Kinotic Server
@@ -588,42 +234,4 @@ EXAMPLES
 ```
 
 _See code: [src/commands/synchronize.ts](https://github.com/kinotic-ai/kinotic/blob/v2.2.0/src/commands/synchronize.ts)_
-
-## `kinotic update [CHANNEL]`
-
-update the kinotic CLI
-
-```
-USAGE
-  $ kinotic update [CHANNEL] [--force |  | [-a | -v <value> | -i]] [-b ]
-
-FLAGS
-  -a, --available        See available versions.
-  -b, --verbose          Show more details about the available versions.
-  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
-  -v, --version=<value>  Install a specific version.
-      --force            Force a re-download of the requested version.
-
-DESCRIPTION
-  update the kinotic CLI
-
-EXAMPLES
-  Update to the stable channel:
-
-    $ kinotic update stable
-
-  Update to a specific version:
-
-    $ kinotic update --version 1.0.0
-
-  Interactively select version:
-
-    $ kinotic update --interactive
-
-  See available versions:
-
-    $ kinotic update --available
-```
-
-_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.7.23/src/commands/update.ts)_
 <!-- commandsstop -->

package/dist/commands/create/project.d.ts

@@ -3,7 +3,11 @@ export declare class Project extends Command {
     static description: string;
     static examples: string[];
     static args: {
-        name: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        organization: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        application: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
     private renderProjectModule;

package/dist/commands/create/project.js

@@ -1,27 +1,36 @@
-import { Args, Command } from '@oclif/core';
+import { Args, Command, Flags } from '@oclif/core';
 import { input, select } from '@inquirer/prompts';
 import chalk from 'chalk';
 import ora from 'ora';
 import path from 'node:path';
 import process from 'node:process';
-import { spawnEngine } from '../../internal/spawn/SpawnEngine.js';
+import { assertPathWithin } from '@kinotic-ai/spawn/node';
+import { fileSystemSpawnEngine } from '../../internal/spawn/FileSystemSpawnEngine.js';
 import { createFrontEnd } from '../../internal/CommandHelper.js';
 export class Project extends Command {
     static description = 'Creates a Kinotic Project';
     static examples = [
-        '$ kinotic create project MyProjectName',
+        '$ kinotic create project MyProjectName --organization acme --application acme-app',
     ];
     static args = {
         name: Args.string({ description: 'The name for the project', required: true })
     };
+    static flags = {
+        organization: Flags.string({ char: 'o', description: 'The organization that owns the project', required: true }),
+        application: Flags.string({ char: 'a', description: 'The application the project belongs to', required: true })
+    };
     async run() {
-        const { args } = await this.parse(Project);
+        const { args, flags } = await this.parse(Project);
         const projectDir = path.resolve(args.name);
-        let context = { projectName: args.name };
+        let context = {
+            projectName: args.name,
+            organization: flags.organization,
+            application: flags.application
+        };
         this.log(chalk.cyan('Creating Kinotic Project'));
         const spinner = ora('Generating project...').start();
         try {
-            context = (await spawnEngine.renderSpawn('project', projectDir, context)) ?? context;
+            context = await fileSystemSpawnEngine.renderSpawn('project', projectDir, context);
             spinner.succeed(chalk.green('Project generated'));
         }
         catch (err) {
@@ -53,10 +62,7 @@ export class Project extends Command {
         } while (choice !== 'Quit');
     }
     async renderProjectModule(spawn, name, projectDir, context) {
-        const dir = path.resolve(name);
-        if (!dir.startsWith(projectDir)) {
-            throw new Error(`Module dir ${dir} must be within ${projectDir}`);
-        }
-        await spawnEngine.renderSpawn(spawn, dir, context);
+        const dir = assertPathWithin(projectDir, name);
+        await fileSystemSpawnEngine.renderSpawn(spawn, dir, context);
     }
 }

package/dist/commands/generate.d.ts

@@ -4,8 +4,8 @@ export declare class Generate extends Command {
     static description: string;
     static examples: string[];
     static flags: {
-        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
     logVerbose(message: string | (() => string), verbose: boolean): void;

package/dist/commands/initialize.d.ts

@@ -4,10 +4,10 @@ export declare class Initialize extends Command {
     static description: string;
     static examples: string[];
     static flags: {
-        application: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        entities: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        repository: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        mirror: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        application: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        entities: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        repository: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        mirror: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
 }

package/dist/commands/login.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@oclif/core';
+export declare class Login extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        server: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/login.js

@@ -0,0 +1,21 @@
+import { Command, Flags } from '@oclif/core';
+import { resolveServer } from '../internal/state/Environment.js';
+import { CliAuthenticator } from '../internal/CliAuthenticator.js';
+export class Login extends Command {
+    static description = 'Log in to a Kinotic Server and store credentials for subsequent commands';
+    static examples = [
+        '$ kinotic login',
+        '$ kinotic login --server http://localhost:9090'
+    ];
+    static flags = {
+        server: Flags.string({ char: 's', description: 'The Kinotic server to log in to' })
+    };
+    async run() {
+        const { flags } = await this.parse(Login);
+        const serverConfig = await resolveServer(this.config.configDir, flags.server);
+        if (!(await new CliAuthenticator(serverConfig.url, this.config.configDir, this).login())) {
+            this.error('Login failed');
+        }
+        this.log(`Logged in to ${serverConfig.url}`);
+    }
+}

package/dist/commands/spawn/lint.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '@oclif/core';
+export declare class Lint extends Command {
+    static description: string;
+    static examples: string[];
+    static args: {
+        dir: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        fix: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private applyFix;
+}

package/dist/commands/spawn/lint.js

@@ -0,0 +1,51 @@
+import { Args, Command, Flags } from '@oclif/core';
+import chalk from 'chalk';
+import fs from 'node:fs';
+import path from 'node:path';
+import { lintSpawnDir } from '@kinotic-ai/spawn/node';
+export class Lint extends Command {
+    static description = 'Reports variables used in a spawn template that are not declared in its spawn.json';
+    static examples = [
+        '$ kinotic spawn lint',
+        '$ kinotic spawn lint ./my-template --fix',
+    ];
+    static args = {
+        dir: Args.string({ description: 'The spawn template directory', default: '.' })
+    };
+    static flags = {
+        fix: Flags.boolean({ description: 'Add stub propertySchema entries for undeclared variables' })
+    };
+    async run() {
+        const { args, flags } = await this.parse(Lint);
+        const dir = path.resolve(args.dir);
+        const { undeclared } = await lintSpawnDir(dir);
+        if (undeclared.length === 0) {
+            this.log(chalk.green('✓ spawn.json declares everything the templates use'));
+            return;
+        }
+        this.log(chalk.yellow('Undeclared variables used in templates:'));
+        for (const variable of undeclared) {
+            this.log(`  ${chalk.bold(variable.name)}  ${chalk.dim(variable.files.join(', '))}`);
+        }
+        if (flags.fix) {
+            this.applyFix(dir, undeclared.map(v => v.name));
+            this.log(chalk.green(`Added ${undeclared.length} stub(s) to spawn.json — fill in description/default.`));
+        }
+        else {
+            this.error('spawn.json is missing declarations (run with --fix to add stubs)', { exit: 1 });
+        }
+    }
+    // Adds a string-typed stub to the root spawn.json's propertySchema for each
+    // undeclared name, leaving existing entries untouched.
+    applyFix(dir, names) {
+        const spawnJsonPath = path.join(dir, 'spawn.json');
+        const config = fs.existsSync(spawnJsonPath)
+            ? JSON.parse(fs.readFileSync(spawnJsonPath, { encoding: 'utf8' }))
+            : {};
+        config.propertySchema ??= {};
+        for (const name of names) {
+            config.propertySchema[name] ??= { type: 'string', description: 'TODO' };
+        }
+        fs.writeFileSync(spawnJsonPath, JSON.stringify(config, null, 2) + '\n');
+    }
+}

package/dist/commands/synchronize.d.ts

@@ -4,12 +4,11 @@ export declare class Synchronize extends Command {
     static description: string;
     static examples: string[];
     static flags: {
-        server: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        publish: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        authHeaderFile: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
-        dryRun: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        server: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        publish: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        verbose: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        dryRun: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
     logVerbose(message: string | (() => string), verbose: boolean): void;