@peernova/cuneiform-sf 1.0.1-beta.2

package/LICENSE

@@ -0,0 +1,36 @@
+Cuneiform CLI - Proprietary Software License
+
+Copyright (c) 2025 PeerNova, Inc. All Rights Reserved.
+
+TERMS AND CONDITIONS
+
+1. GRANT OF LICENSE
+   This software is licensed, not sold. Subject to a valid Cuneiform
+   subscription agreement, PeerNova, Inc. grants you a limited, non-exclusive,
+   non-transferable license to use this software solely in connection
+   with Cuneiform products.
+
+2. RESTRICTIONS
+   You may NOT:
+   - Modify, adapt, or create derivative works
+   - Reverse engineer, decompile, or disassemble
+   - Remove or alter proprietary notices
+   - Redistribute, sublicense, or transfer
+   - Use without a valid Cuneiform subscription
+
+3. NO WARRANTY
+   THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
+   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+
+4. LIMITATION OF LIABILITY
+   IN NO EVENT SHALL PEERNOVA, INC. BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+   DEALINGS IN THE SOFTWARE.
+
+5. TERMINATION
+   This license terminates automatically if you violate any terms
+   or if your Cuneiform subscription expires or is terminated.
+
+For licensing inquiries: legal@peernova.com

package/README.md

@@ -0,0 +1,185 @@
+# @peernova/cuneiform-sf
+
+[![NPM](https://img.shields.io/npm/v/@peernova/cuneiform-sf.svg?label=@peernova/cuneiform-sf)](https://www.npmjs.com/package/@peernova/cuneiform-sf) [![Downloads/week](https://img.shields.io/npm/dw/@peernova/cuneiform-sf.svg)](https://npmjs.org/package/@peernova/cuneiform-sf) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/@peernova/cuneiform-sf/main/LICENSE.txt)
+
+## Using the template
+
+This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
+
+1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.
+2. Generate your plugin:
+
+   ```
+   sf plugins install dev
+   sf dev generate plugin
+
+   git init -b main
+   git add . && git commit -m "chore: initial commit"
+   ```
+
+3. Create your plugin's repo in the salesforcecli github org
+4. When you're ready, replace the contents of this README with the information you want.
+
+## Learn about `sf` plugins
+
+Salesforce CLI plugins are based on the [oclif plugin framework](<(https://oclif.io/docs/introduction.html)>). Read the [plugin developer guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_architecture_sf_cli.htm) to learn about Salesforce CLI plugin development.
+
+This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the [node developer packages](#tooling) used by Salesforce.
+
+Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the `posttest` script and it is required to keep these tests active in your plugin if you plan to have it bundled.
+
+### Tooling
+
+- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)
+- [@salesforce/kit](https://github.com/forcedotcom/kit)
+- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)
+- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)
+- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)
+- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
+- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
+
+### Hooks
+
+For cross clouds commands, e.g. `sf env list`, we utilize [oclif hooks](https://oclif.io/docs/hooks) to get the relevant information from installed plugins.
+
+This plugin includes sample hooks in the [src/hooks directory](src/hooks). You'll just need to add the appropriate logic. You can also delete any of the hooks if they aren't required for your plugin.
+
+# Everything past here is only a suggestion as to what should be in your specific plugin's description
+
+This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).
+
+We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.
+
+## Install
+
+```bash
+sf plugins install @peernova/cuneiform-sf@x.y.z
+```
+
+## Issues
+
+Please report any issues at https://github.com/forcedotcom/cli/issues
+
+## Contributing
+
+1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
+2. Create a new issue before starting your project so that we can keep track of
+   what you are trying to add/fix. That way, we can also offer suggestions or
+   let you know if there is already an effort in progress.
+3. Fork this repository.
+4. [Build the plugin locally](#build)
+5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
+6. Edit the code in your fork.
+7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
+8. Sign CLA (see [CLA](#cla) below).
+9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
+
+### CLA
+
+External contributors will be required to sign a Contributor's License
+Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
+
+### Build
+
+To build the plugin locally, make sure to have yarn installed and run the following commands:
+
+```bash
+# Clone the repository
+git clone git@github.com:salesforcecli/@peernova/cuneiform-sf
+
+# Install the dependencies and compile
+yarn && yarn build
+```
+
+To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
+
+```bash
+# Run using local run file.
+./bin/dev hello world
+```
+
+There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
+
+```bash
+# Link your plugin to the sf cli
+sf plugins link .
+# To verify
+sf plugins
+```
+
+## Commands
+
+<!-- commands -->
+
+- [`sf cuneiform about`](#sf-cuneiform-about)
+- [`sf hello world`](#sf-hello-world)
+
+## `sf cuneiform about`
+
+Summary of a command.
+
+```
+USAGE
+  $ sf cuneiform about [--json] [--flags-dir <value>] [-n <value>]
+
+FLAGS
+  -n, --name=<value>  Description of a flag.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Summary of a command.
+
+  More information about a command. Don't repeat the summary.
+
+EXAMPLES
+  $ sf cuneiform about
+
+FLAG DESCRIPTIONS
+  -n, --name=<value>  Description of a flag.
+
+    More information about a flag. Don't repeat the summary.
+```
+
+_See code: [src/commands/cuneiform/about.ts](https://github.com/PeerNova-Solutions/cuneiform-cli/blob/1.0.1-beta.2/src/commands/cuneiform/about.ts)_
+
+## `sf hello world`
+
+Say hello.
+
+```
+USAGE
+  $ sf hello world [--json] [--flags-dir <value>] [-n <value>]
+
+FLAGS
+  -n, --name=<value>  [default: World] The name of the person you'd like to say hello to.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Say hello.
+
+  Say hello either to the world or someone you know.
+
+EXAMPLES
+  Say hello to the world:
+
+    $ sf hello world
+
+  Say hello to someone you know:
+
+    $ sf hello world --name Astro
+
+FLAG DESCRIPTIONS
+  -n, --name=<value>  The name of the person you'd like to say hello to.
+
+    This person can be anyone in the world!
+```
+
+_See code: [src/commands/hello/world.ts](https://github.com/PeerNova-Solutions/cuneiform-cli/blob/1.0.1-beta.2/src/commands/hello/world.ts)_
+
+<!-- commandsstop -->

package/lib/commands/cuneiform/about.d.ts

@@ -0,0 +1,13 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type CuneiformAboutResult = {
+    path: string;
+};
+export default class CuneiformAbout extends SfCommand<CuneiformAboutResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<CuneiformAboutResult>;
+}

package/lib/commands/cuneiform/about.js

@@ -0,0 +1,26 @@
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@peernova/cuneiform-sf', 'cuneiform.about');
+export default class CuneiformAbout extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        name: Flags.string({
+            summary: messages.getMessage('flags.name.summary'),
+            description: messages.getMessage('flags.name.description'),
+            char: 'n',
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(CuneiformAbout);
+        const name = flags.name ?? 'world';
+        this.log(`hello ${name} from src/commands/cuneiform/about.ts`);
+        return {
+            path: 'src/commands/cuneiform/about.ts',
+        };
+    }
+}
+//# sourceMappingURL=about.js.map

package/lib/commands/cuneiform/about.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"about.js","sourceRoot":"","sources":["../../../src/commands/cuneiform/about.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,wBAAwB,EAAE,iBAAiB,CAAC,CAAC;AAMpF,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,SAA+B;IAClE,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YAC1D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;SAChB,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,OAAO,CAAC;QACnC,IAAI,CAAC,GAAG,CAAC,SAAS,IAAI,uCAAuC,CAAC,CAAC;QAC/D,OAAO;YACL,IAAI,EAAE,iCAAiC;SACxC,CAAC;IACJ,CAAC"}

package/lib/commands/hello/world.d.ts

@@ -0,0 +1,14 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type HelloWorldResult = {
+    name: string;
+    time: string;
+};
+export default class World extends SfCommand<HelloWorldResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        name: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<HelloWorldResult>;
+}

package/lib/commands/hello/world.js

@@ -0,0 +1,27 @@
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@peernova/cuneiform-sf', 'hello.world');
+export default class World extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        name: Flags.string({
+            char: 'n',
+            summary: messages.getMessage('flags.name.summary'),
+            description: messages.getMessage('flags.name.description'),
+            default: 'World',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(World);
+        const time = new Date().toDateString();
+        this.log(messages.getMessage('info.hello', [flags.name, time]));
+        return {
+            name: flags.name,
+            time,
+        };
+    }
+}
+//# sourceMappingURL=world.js.map

package/lib/commands/hello/world.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"world.js","sourceRoot":"","sources":["../../../src/commands/hello/world.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,wBAAwB,EAAE,aAAa,CAAC,CAAC;AAOhF,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,SAA2B;IACrD,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YAC1D,OAAO,EAAE,OAAO;SACjB,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,YAAY,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAChE,OAAO;YACL,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI;SACL,CAAC;IACJ,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/lib/index.js

@@ -0,0 +1,2 @@
+export default {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAe,EAAE,CAAC"}

package/messages/cuneiform.about.md

@@ -0,0 +1,19 @@
+# summary
+
+Summary of a command.
+
+# description
+
+More information about a command. Don't repeat the summary.
+
+# flags.name.summary
+
+Description of a flag.
+
+# flags.name.description
+
+More information about a flag. Don't repeat the summary.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>

package/messages/hello.world.md

@@ -0,0 +1,29 @@
+# summary
+
+Say hello.
+
+# description
+
+Say hello either to the world or someone you know.
+
+# flags.name.summary
+
+The name of the person you'd like to say hello to.
+
+# flags.name.description
+
+This person can be anyone in the world!
+
+# examples
+
+- Say hello to the world:
+
+  <%= config.bin %> <%= command.id %>
+
+- Say hello to someone you know:
+
+  <%= config.bin %> <%= command.id %> --name Astro
+
+# info.hello
+
+Hello %s at %s.