@contextual-io/cli 0.1.1

package/README.md

@@ -0,0 +1,353 @@
+contextual-cli
+=================
+
+Contextual CLI
+
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/contextual-cli.svg)](https://npmjs.org/package/contextual-cli)
+[![Downloads/week](https://img.shields.io/npm/dw/contextual-cli.svg)](https://npmjs.org/package/contextual-cli)
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @contextual-io/cli
+$ ctxl COMMAND
+running command...
+$ ctxl (--version)
+@contextual-io/cli/0.1.1 linux-x64 node-v25.2.1
+$ ctxl --help [COMMAND]
+USAGE
+  $ ctxl COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`ctxl help [COMMAND]`](#ctxl-help-command)
+* [`ctxl plugins`](#ctxl-plugins)
+* [`ctxl plugins add PLUGIN`](#ctxl-plugins-add-plugin)
+* [`ctxl plugins:inspect PLUGIN...`](#ctxl-pluginsinspect-plugin)
+* [`ctxl plugins install PLUGIN`](#ctxl-plugins-install-plugin)
+* [`ctxl plugins link PATH`](#ctxl-plugins-link-path)
+* [`ctxl plugins remove [PLUGIN]`](#ctxl-plugins-remove-plugin)
+* [`ctxl plugins reset`](#ctxl-plugins-reset)
+* [`ctxl plugins uninstall [PLUGIN]`](#ctxl-plugins-uninstall-plugin)
+* [`ctxl plugins unlink [PLUGIN]`](#ctxl-plugins-unlink-plugin)
+* [`ctxl plugins update`](#ctxl-plugins-update)
+
+## `ctxl help [COMMAND]`
+
+Display help for ctxl.
+
+```
+USAGE
+  $ ctxl 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 ctxl.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
+
+## `ctxl plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ ctxl plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ ctxl plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/index.ts)_
+
+## `ctxl plugins add PLUGIN`
+
+Installs a plugin into ctxl.
+
+```
+USAGE
+  $ ctxl 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 ctxl.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the CTXL_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the CTXL_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ ctxl plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ ctxl plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ ctxl plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ ctxl plugins add someuser/someplugin
+```
+
+## `ctxl plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ ctxl 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
+  $ ctxl plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/inspect.ts)_
+
+## `ctxl plugins install PLUGIN`
+
+Installs a plugin into ctxl.
+
+```
+USAGE
+  $ ctxl 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 ctxl.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the CTXL_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the CTXL_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ ctxl plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ ctxl plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ ctxl plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ ctxl plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/install.ts)_
+
+## `ctxl plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ ctxl 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
+  $ ctxl plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/link.ts)_
+
+## `ctxl plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ ctxl 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
+  $ ctxl plugins unlink
+  $ ctxl plugins remove
+
+EXAMPLES
+  $ ctxl plugins remove myplugin
+```
+
+## `ctxl plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ ctxl 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/v5.4.54/src/commands/plugins/reset.ts)_
+
+## `ctxl plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ ctxl 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
+  $ ctxl plugins unlink
+  $ ctxl plugins remove
+
+EXAMPLES
+  $ ctxl plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.54/src/commands/plugins/uninstall.ts)_
+
+## `ctxl plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ ctxl 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
+  $ ctxl plugins unlink
+  $ ctxl plugins remove
+
+EXAMPLES
+  $ ctxl plugins unlink myplugin
+```
+
+## `ctxl plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ ctxl 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/v5.4.54/src/commands/plugins/update.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import { execute } from "@oclif/core"
+
+await execute({ development: true, dir: import.meta.url })

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from "@oclif/core"
+
+await execute({ dir: import.meta.url })

package/oclif.manifest.json

@@ -0,0 +1,4 @@
+{
+  "commands": {},
+  "version": "0.1.1"
+}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@contextual-io/cli",
+  "description": "Contextual CLI",
+  "version": "0.1.1",
+  "author": "Nasser Oloumi",
+  "bin": {
+    "ctxl": "./bin/run.js"
+  },
+  "bugs": "https://github.com/ContextualIO/contextual-cli/issues",
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5",
+    "@oclif/table": "^0.5.1",
+    "chalk": "^5.6.2",
+    "cross-fetch": "^4.1.0",
+    "open": "^11.0.0",
+    "stream-json": "^1.9.1",
+    "zod": "4.1.12"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@stylistic/eslint-plugin": "^5.6.1",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "@types/stream-json": "^1.7.8",
+    "chai": "^4",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "eslint-plugin-unused-imports": "^4.3.0",
+    "mocha": "^10",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "ts-node": "^10",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/ContextualIO/contextual-cli",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "ctxl",
+    "dirname": "ctxl",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "repository": "ContextualIO/contextual-cli",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "pnpm run lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "types": "dist/index.d.ts"
+}