create-codama-clients 1.0.0

package/README.md

@@ -0,0 +1,90 @@
+# create-codama-clients
+
+Zero config, ero installation tool that makes TypeScript clients from your Solana program IDLs.
+
+Just run `npx create-codama-clients`. This package will download, find all IDL files in your project, and generate TypeScript clients for all your programs with one command.
+
+## The problem this solves
+
+The Codama CLI (`codama run`) requires:
+
+- A `codama.json` config file for each program
+- Manual configuration of IDL paths and output directories
+- Separate commands or shell scripts to handle multiple programs
+
+With `create-codama-clients`, you can generate clients for all your programs in one command, with zero configuration.
+
+## Usage
+
+### Basic usage (recommended)
+
+```bash
+npx create-codama-clients
+```
+
+This will:
+
+1. Look for IDL files in `target/idl/` (Anchor's default location)
+2. Generate a TypeScript client for each IDL found
+3. Output clients to `dist/<idl-name>-client/` folders (e.g., `dist/election-client/`)
+
+### Custom directories
+
+```bash
+npx create-codama-clients --idl-dir ./idls --output-dir ./clients
+```
+
+### Options
+
+```
+-i, --idl-dir <dir>      Directory containing IDL files (default: target/idl)
+-o, --output-dir <dir>   Directory for generated clients (default: dist)
+-h, --help               Show this help message
+```
+
+## Example output
+
+```
+🔍 Searching for IDL files in target/idl...
+📦 Found 2 IDL file(s)
+✅ Generated client for election at dist/election-client
+✅ Generated client for voting at dist/voting-client
+
+🎉 Successfully generated 2 client(s)
+```
+
+Each generated client folder (e.g., `dist/election-client/`) contains:
+
+- TypeScript types for your program's accounts and instructions
+- Helper functions for interacting with your program
+- Full compatibility with `@solana/kit`
+
+## Requirements
+
+Your project should have IDL files (JSON format) from:
+
+- Anchor programs (`anchor build` generates these in `target/idl/`)
+- Shank-based programs
+- Any other Codama-compatible IDL format
+
+## How it works
+
+For each IDL file found:
+
+1. Loads the IDL JSON
+2. Converts it to a Codama root node using `@codama/nodes-from-anchor`
+3. Generates TypeScript client code using `@codama/renderers-js`
+4. Outputs to `<output-dir>/<idl-filename>-client/` (the `-client` suffix is automatically appended)
+
+## Comparison with Codama CLI
+
+| Feature           | `create-codama-clients` | `codama run`              |
+| ----------------- | ----------------------- | ------------------------- |
+| Installation      | None (npx)              | Requires local install    |
+| Configuration     | Zero config             | Requires codama.json      |
+| Multiple programs | Automatic               | Manual config per program |
+| Discovery         | Auto-finds IDLs         | Manual paths              |
+
+## License
+
+ISC

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+import { createFromRoot } from "codama";
+import { rootNodeFromAnchor } from "@codama/nodes-from-anchor";
+import { renderVisitor } from "@codama/renderers-js";
+import path from "path";
+import { promises as fs } from "fs";
+import { glob } from "glob";
+const parseArgs = () => {
+    const args = process.argv.slice(2);
+    const options = {
+        idlDir: "target/idl",
+        outputDir: "dist",
+    };
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (!arg)
+            continue;
+        if (arg === "--idl-dir" || arg === "-i") {
+            const nextArg = args[i + 1];
+            if (!nextArg) {
+                throw new Error(`${arg} requires a value`);
+            }
+            options.idlDir = nextArg;
+            i++;
+        }
+        else if (arg === "--output-dir" || arg === "-o") {
+            const nextArg = args[i + 1];
+            if (!nextArg) {
+                throw new Error(`${arg} requires a value`);
+            }
+            options.outputDir = nextArg;
+            i++;
+        }
+        else if (arg === "--help" || arg === "-h") {
+            console.log(`
+Usage: npx create-codama-clients [options]
+
+Options:
+  -i, --idl-dir <dir>      Directory containing IDL files (default: target/idl)
+  -o, --output-dir <dir>   Directory for generated clients (default: dist)
+  -h, --help               Show this help message
+
+Examples:
+  npx create-codama-clients
+  npx create-codama-clients --idl-dir ./idls --output-dir ./clients
+`);
+            process.exit(0);
+        }
+        else {
+            throw new Error(`Unknown option: ${arg}`);
+        }
+    }
+    return options;
+};
+const findIDLFiles = async (idlDir) => {
+    const pattern = path.join(idlDir, "*.json");
+    const files = await glob(pattern);
+    if (files.length === 0) {
+        throw new Error(`No JSON files found in ${idlDir}`);
+    }
+    return files;
+};
+const loadIDL = async (filePath) => {
+    try {
+        const content = await fs.readFile(filePath, "utf-8");
+        return JSON.parse(content);
+    }
+    catch (error) {
+        throw new Error(`Failed to load IDL from ${filePath}: ${error}`);
+    }
+};
+const generateClient = async (idlPath, outputDir) => {
+    const idl = await loadIDL(idlPath);
+    const fileName = path.basename(idlPath, ".json");
+    const clientOutputPath = path.join(outputDir, `${fileName}-client`);
+    const codama = createFromRoot(rootNodeFromAnchor(idl));
+    codama.accept(renderVisitor(clientOutputPath));
+    console.log(`✅ Generated client for ${fileName} at ${clientOutputPath}`);
+};
+const main = async () => {
+    try {
+        const options = parseArgs();
+        console.log(`🔍 Searching for IDL files in ${options.idlDir}...`);
+        const idlFiles = await findIDLFiles(options.idlDir);
+        console.log(`📦 Found ${idlFiles.length} IDL file(s)`);
+        for (const idlFile of idlFiles) {
+            await generateClient(idlFile, options.outputDir);
+        }
+        console.log(`\n🎉 Successfully generated ${idlFiles.length} client(s)`);
+    }
+    catch (error) {
+        console.error(`❌ Error: ${error instanceof Error ? error.message : error}`);
+        process.exit(1);
+    }
+};
+main();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAkB,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAO5B,MAAM,SAAS,GAAG,GAAe,EAAE;IACjC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,OAAO,GAAe;QAC1B,MAAM,EAAE,YAAY;QACpB,SAAS,EAAE,MAAM;KAClB,CAAC;IAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,GAAG;YAAE,SAAS;QAEnB,IAAI,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACxC,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5B,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,mBAAmB,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC;YACzB,CAAC,EAAE,CAAC;QACN,CAAC;aAAM,IAAI,GAAG,KAAK,cAAc,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAClD,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5B,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,mBAAmB,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC;YAC5B,CAAC,EAAE,CAAC;QACN,CAAC;aAAM,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC5C,OAAO,CAAC,GAAG,CAAC;;;;;;;;;;;CAWjB,CAAC,CAAC;YACG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,KAAK,EAAE,MAAc,EAA0B,EAAE;IACpE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;IAElC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,KAAK,EAAE,QAAgB,EAAsB,EAAE;IAC7D,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAc,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,QAAQ,KAAK,KAAK,EAAE,CAAC,CAAC;IACnE,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,KAAK,EAC1B,OAAe,EACf,SAAiB,EACF,EAAE;IACjB,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,QAAQ,SAAS,CAAC,CAAC;IAEpE,MAAM,MAAM,GAAG,cAAc,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;IACvD,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAE/C,OAAO,CAAC,GAAG,CAAC,0BAA0B,QAAQ,OAAO,gBAAgB,EAAE,CAAC,CAAC;AAC3E,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IACrC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;QAE5B,OAAO,CAAC,GAAG,CAAC,iCAAiC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,CAAC,MAAM,cAAc,CAAC,CAAC;QAEvD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,+BAA+B,QAAQ,CAAC,MAAM,YAAY,CAAC,CAAC;IAC1E,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,YAAY,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAC5E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "create-codama-clients",
+  "version": "1.0.0",
+  "description": "Auto-discover and batch-generate Codama TypeScript clients from Solana program IDLs",
+  "main": "dist/cli.js",
+  "type": "module",
+  "bin": {
+    "create-codama-clients": "./dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "solana",
+    "codama",
+    "idl",
+    "client-generation",
+    "anchor",
+    "typescript"
+  ],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^25.0.9",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@codama/nodes-from-anchor": "^1.3.8",
+    "@codama/renderers-js": "^1.5.5",
+    "codama": "^1.5.0",
+    "glob": "^13.0.0"
+  }
+}

package/src/cli.ts

@@ -0,0 +1,115 @@
+#!/usr/bin/env node
+
+import { createFromRoot } from "codama";
+import { rootNodeFromAnchor, type AnchorIdl } from "@codama/nodes-from-anchor";
+import { renderVisitor } from "@codama/renderers-js";
+import path from "path";
+import { promises as fs } from "fs";
+import { glob } from "glob";
+
+interface CLIOptions {
+  idlDir: string;
+  outputDir: string;
+}
+
+const parseArgs = (): CLIOptions => {
+  const args = process.argv.slice(2);
+  const options: CLIOptions = {
+    idlDir: "target/idl",
+    outputDir: "dist",
+  };
+
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    if (!arg) continue;
+
+    if (arg === "--idl-dir" || arg === "-i") {
+      const nextArg = args[i + 1];
+      if (!nextArg) {
+        throw new Error(`${arg} requires a value`);
+      }
+      options.idlDir = nextArg;
+      i++;
+    } else if (arg === "--output-dir" || arg === "-o") {
+      const nextArg = args[i + 1];
+      if (!nextArg) {
+        throw new Error(`${arg} requires a value`);
+      }
+      options.outputDir = nextArg;
+      i++;
+    } else if (arg === "--help" || arg === "-h") {
+      console.log(`
+Usage: npx create-codama-clients [options]
+
+Options:
+  -i, --idl-dir <dir>      Directory containing IDL files (default: target/idl)
+  -o, --output-dir <dir>   Directory for generated clients (default: dist)
+  -h, --help               Show this help message
+
+Examples:
+  npx create-codama-clients
+  npx create-codama-clients --idl-dir ./idls --output-dir ./clients
+`);
+      process.exit(0);
+    } else {
+      throw new Error(`Unknown option: ${arg}`);
+    }
+  }
+
+  return options;
+};
+
+const findIDLFiles = async (idlDir: string): Promise<Array<string>> => {
+  const pattern = path.join(idlDir, "*.json");
+  const files = await glob(pattern);
+
+  if (files.length === 0) {
+    throw new Error(`No JSON files found in ${idlDir}`);
+  }
+
+  return files;
+};
+
+const loadIDL = async (filePath: string): Promise<AnchorIdl> => {
+  try {
+    const content = await fs.readFile(filePath, "utf-8");
+    return JSON.parse(content) as AnchorIdl;
+  } catch (error) {
+    throw new Error(`Failed to load IDL from ${filePath}: ${error}`);
+  }
+};
+
+const generateClient = async (
+  idlPath: string,
+  outputDir: string
+): Promise<void> => {
+  const idl = await loadIDL(idlPath);
+  const fileName = path.basename(idlPath, ".json");
+  const clientOutputPath = path.join(outputDir, `${fileName}-client`);
+
+  const codama = createFromRoot(rootNodeFromAnchor(idl));
+  codama.accept(renderVisitor(clientOutputPath));
+
+  console.log(`✅ Generated client for ${fileName} at ${clientOutputPath}`);
+};
+
+const main = async (): Promise<void> => {
+  try {
+    const options = parseArgs();
+
+    console.log(`🔍 Searching for IDL files in ${options.idlDir}...`);
+    const idlFiles = await findIDLFiles(options.idlDir);
+    console.log(`📦 Found ${idlFiles.length} IDL file(s)`);
+
+    for (const idlFile of idlFiles) {
+      await generateClient(idlFile, options.outputDir);
+    }
+
+    console.log(`\n🎉 Successfully generated ${idlFiles.length} client(s)`);
+  } catch (error) {
+    console.error(`❌ Error: ${error instanceof Error ? error.message : error}`);
+    process.exit(1);
+  }
+};
+
+main();

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "module": "nodenext",
+    "target": "esnext",
+    "lib": ["esnext"],
+    "types": ["node"],
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "strict": true,
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"]
+}