create-abi

Create abi 🦾

The Ultimate Starter for Abi.js Projects

Seamlessly scaffold content-driven web projects with the power of Abi.js. Whether you're building blazing-fast blogs, portfolios, or scalable applications, this CLI has you covered.

Quickstart 🎉

To create a brand new project, you can use the following command:

npm create abi@latest

🚀 Installation & Usage

🧑‍💻 Usage

Run the following command using your preferred package manager:

• With NPM:

  npm create abi@latest [destination] [runtime] [...options]
  

• With Yarn:

  yarn create abi [destination] [runtime] [...options]
  

• With PNPM:

  pnpm create abi [destination] [runtime] [...options]
  

• With Bun:

  bun create abi [destination] [runtime] [...options]
  

🛠️ Flags

Arguments

Customize the command with the following arguments:

Name	Type	Default value	Description
destination	String	./abi-app	Directory of the project.
runtime	"node" or "deno" or "bun"	node	JavaScript/TypeScript runtime to use.

Options

Enhance your project setup with these additional flags:

Name	Shortcut	Description
--help	-h	Display all available options.
--force / --no-force	-f / --no-f	Overwrite target directory, if needed.
--install / --no-install	-i / --no-i	Automatically install dependencies.
--git / --no-git		Use Git to save changes.
--yes	-y	Accept all default configurations.
--no	-n	Decline all default configurations.
--dry-run		Simulate the setup process without executing.

💡 Examples

The easiest way to explore Abi.js on your machine is by running the following command:

npm create abi@latest

You can combine multiple flags to set up your project exactly as needed:

npm create abi my-abi-project --yes --no-git --no-ci

📦 API

For developers looking to programmatically access the CLI functionality:

• Basic Usage

  Run the CLI programmatically without arguments:

  import createAbi from 'create-abi';
  
  createAbi();
  

• With Custom Arguments

  Specify arguments directly:

  import { run } from 'create-abi';
  
  run(["./abi-app", "node"]);
  

• Definition Types

  Define the structure of the CLI options and arguments:

  export type Definition = {
    destination: string;
    runtime?: "node" | "deno" | "bun";
    force?: boolean;
    install?: boolean;
    git?: boolean;
    yes?: boolean;
    no?: boolean;
    dryRun?: boolean;
  };
  

• Default Settings

  Here are the default configurations:

  export const defaultDefinition = {
    destination: "./abi-app",
    runtime: "node",
    force: undefined,
    install: undefined,
    git: undefined,
    yes: undefined,
    no: undefined,
    dryRun: undefined
  } as const;
  

🌐 Community

• Ping @abidotjs on 𝕏