@shuffl/cli 0.6.0 → 0.6.2

package/README.md

@@ -71,3 +71,7 @@ shuffl logout --company
 Or set `SHUFFL_COMPANY_KEY` and `SHUFFL_BASE_URL`. The company key is saved in `company.json` next to `config.json`, and only `shuffl company` commands send it; `shuffl logout --company` removes it. Each command's `--help` names its company permission. See [company keys](https://shuffl-rebuild.vercel.app/docs/api-permissions#company-keys).
 
 Full guide: [Use the Shuffl CLI](https://shuffl-rebuild.vercel.app/docs/cli).
+
+## License
+
+MIT © Shuffl LLC. See [LICENSE](./LICENSE).

package/dist/index.js

@@ -7,6 +7,8 @@ import { ORPCError, Shuffl } from '@shuffl/sdk';
 import { commands } from './commands.generated.js';
 // package.json sits one level above both src/ and dist/.
 const { version } = createRequire(import.meta.url)('../package.json');
+// Sent ahead of the SDK's own in x-shuffl-client, so Shuffl counts CLI use.
+const cliClient = `shuffl-cli/${version}`;
 async function request(run) {
     try {
         return await run();
@@ -109,7 +111,7 @@ export async function runCli(args, io = {
         const configDirectory = io.env.SHUFFL_CONFIG_DIR ??
             join(io.env.XDG_CONFIG_HOME ?? join(homedir(), '.config'), 'shuffl');
         const configFile = join(configDirectory, 'config.json');
-        // #1692: a company key is saved apart from the workspace key, and only
+        // A company key is saved apart from the workspace key, and only
         // `shuffl company` commands send it.
         const companyFile = join(configDirectory, 'company.json');
         if (flags.version && !positional.length) {
@@ -144,7 +146,11 @@ export async function runCli(args, io = {
                 if (!/^shuffl_company_[A-Za-z0-9_-]{43}$/.test(token))
                     throw new Error('Expected a Shuffl company key.');
                 const baseUrl = new URL(flags['base-url']).origin;
-                const company = await request(() => new Shuffl({ apiKey: token, baseUrl }).company.current());
+                const company = await request(() => new Shuffl({
+                    apiKey: token,
+                    baseUrl,
+                    client: cliClient,
+                }).company.current());
                 await save(companyFile, { baseUrl, token });
                 io.stdout(json
                     ? JSON.stringify({ company }) + '\n'
@@ -157,6 +163,7 @@ export async function runCli(args, io = {
             const client = new Shuffl({
                 apiKey: token,
                 baseUrl,
+                client: cliClient,
             });
             const team = await request(() => client.teams.current());
             await save(configFile, { baseUrl, token });
@@ -211,8 +218,8 @@ export async function runCli(args, io = {
             new URL(baseUrl).origin !== new URL(saved.baseUrl).origin)
             throw new Error('Saved credentials belong to a different server. Sign in to the target server first.');
         let method = company
-            ? new Shuffl({ apiKey: token, baseUrl }).company
-            : new Shuffl({ apiKey: token, baseUrl });
+            ? new Shuffl({ apiKey: token, baseUrl, client: cliClient }).company
+            : new Shuffl({ apiKey: token, baseUrl, client: cliClient });
         for (const name of command.path)
             method = method[name];
         const output = await request(() => method(input));

package/dist/types.d.ts

@@ -13,6 +13,6 @@ export interface CommandDefinition {
     summary: string;
     scope: string | null;
     input: JsonSchema | null;
-    /** company: a company key command, under `shuffl company` (#1692). */
+    /** company: a company key command, under `shuffl company`. */
     credential?: 'company';
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "dependencies": {
     "@orpc/client": "1.15.3",
-    "@shuffl/api-contracts": "0.6.0",
-    "@shuffl/sdk": "0.6.0"
+    "@shuffl/api-contracts": "0.6.2",
+    "@shuffl/sdk": "0.6.2"
   },
   "description": "Shuffl command line: every public API operation as a scriptable command with JSON output.",
   "engines": {
@@ -33,7 +33,7 @@
   "sideEffects": false,
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "bin": {
     "shuffl": "./dist/bin.js"
   }