@akanjs/cli 2.3.5-rc.7 → 2.3.5-rc.9

package/index.js

@@ -13892,7 +13892,8 @@ class WorkspaceRunner extends runner("workspace") {
     dirname: dirname2 = ".",
     init = true,
     akanVersion,
-    registryUrl
+    registryUrl,
+    owner
   }) {
     const cwdPath = process.cwd();
     const workspaceRoot = path41.join(cwdPath, dirname2, repoName);
@@ -14039,14 +14040,16 @@ class WorkspaceScript extends script("workspace", [
     dirname: dirname2 = ".",
     installLibs = false,
     init = true,
-    registryUrl
+    registryUrl,
+    owner
   }) {
     const akanVersion = await this.packageScript.version(null, { log: false });
     const workspace = await this.workspaceRunner.createWorkspace(repoName, appName, {
       dirname: dirname2,
       init,
       akanVersion,
-      ...registryUrl ? { registryUrl } : {}
+      ...registryUrl ? { registryUrl } : {},
+      ...owner ? { owner } : {}
     });
     if (installLibs) {
       await this.libraryScript.installLibrary(workspace, "util");
@@ -14153,6 +14156,10 @@ class WorkspaceCommand extends command("workspace", [WorkspaceScript], ({ public
   }).option("registry", String, {
     desc: "npm registry URL for installing Akan packages",
     default: process.env.AKAN_NPM_REGISTRY ?? "https://registry.npmjs.org"
+  }).option("owner", String, {
+    desc: "owner of the workspace",
+    default: process.env.GITHUB_OWNER,
+    nullable: true
   }).exec(async function(workspaceName, app, dir, libs, init, registry) {
     const appName = app || "app";
     await this.workspaceScript.createWorkspace(workspaceName.toLowerCase().replace(/ /g, "-"), appName.toLowerCase().replace(/ /g, "-"), { dirname: dir, installLibs: libs, init, ...registry ? { registryUrl: registry } : {} });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akanjs/cli",
-  "version": "2.3.5-rc.7",
+  "version": "2.3.5-rc.9",
   "sourceType": "module",
   "type": "module",
   "publishConfig": {
@@ -35,7 +35,7 @@
     "@langchain/openai": "^1.4.6",
     "@tailwindcss/node": "^4.3.0",
     "@trapezedev/project": "^7.1.4",
-    "akanjs": "2.3.5-rc.7",
+    "akanjs": "2.3.5-rc.9",
     "chalk": "^5.6.2",
     "commander": "^14.0.3",
     "daisyui": "^5.5.20",

package/templates/workspaceRoot/README.ts

@@ -0,0 +1,78 @@
+interface Dict {
+  appName: string;
+  owner?: string;
+  repoName: string;
+}
+export default function getContent(_scanInfo: null, dict: Dict) {
+  const codespacesUrl = `https://codespaces.new/${dict.owner}/${dict.repoName}?quickstart=1`;
+  const codespacesBadge = dict.owner
+    ? `[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](${codespacesUrl})`
+    : "";
+
+  return {
+    filename: "README.md",
+    content: `${codespacesBadge}
+# ${dict.repoName}
+
+This workspace was created with [Akan.js](https://akanjs.com), a Bun-first full-stack TypeScript framework.
+
+Akan lets you write business code once and connect it across web, server, fetch clients, state, database contracts,
+and deployment artifacts with strict conventions.
+
+## Quick Start
+
+Install dependencies:
+
+\`\`\`bash
+bun install
+bun install -g @akanjs/cli
+\`\`\`
+
+Start the app:
+
+\`\`\`bash
+akan start ${dict.appName} --open
+\`\`\`
+
+Build for production:
+
+\`\`\`bash
+akan build ${dict.appName}
+\`\`\`
+
+## Project Structure
+
+\`\`\`text
+apps/${dict.appName}/
+|-- akan.config.ts      # app configuration
+|-- page/               # route pages
+|-- lib/                # app domain modules
+|-- ui/                 # app UI components
+|-- env/                # runtime environment contracts
+\`-- public/             # static assets
+
+libs/                   # shared libraries for multiple apps
+pkgs/                   # local packages, if your workspace grows into them
+\`\`\`
+
+## Where To Start
+
+- Edit \`apps/${dict.appName}/page/_index.tsx\` to change the first page.
+- Edit \`apps/${dict.appName}/akan.config.ts\` when the app needs routes, domains, base paths, or deployment options.
+- Add business modules under \`apps/${dict.appName}/lib/\` when your app needs typed domain logic.
+
+## Useful Commands
+
+\`\`\`bash
+akan start ${dict.appName}
+akan build ${dict.appName}
+akan lint ${dict.appName}
+\`\`\`
+
+## Learn More
+
+- Akan.js docs: https://akanjs.com/docs
+- Package: https://www.npmjs.com/package/akanjs
+`,
+  };
+}