Kimia Framework CLI

A powerful command-line interface tool to scaffold, manage, and develop applications using the Kimia Framework.

Installation

You can install the Kimia CLI globally via npm or pnpm to use it anywhere on your system:

# Using npm
npm install -g @kimia-framework/cli

# Using pnpm
pnpm add -g @kimia-framework/cli

Usage

Once installed globally, you can use the kimia command to create new apps, initialize the core framework, or start your development environment.

kimia [command] [options]

Commands

kimia create-app <app-name> [lang]

Creates a new Kimia application in a new directory with the specified name.

Alias: a

Arguments:

• <app-name>: The name of your application (required).
• [lang]: The default language/locale of the application (default: fa).

Options:

• -m, --multiple: Enables advanced mode for managing multiple applications under one project. This requires pnpm to be installed and uses workspace dependencies for the core framework.

Examples:

# Create a simple app
kimia create-app my-oil-app fa

# Create an app in advanced/multiple mode
kimia create-app my-oil-app fa -m

kimia init-core

Downloads and sets up the Kimia Framework core (@kimia-framework/core) in a core directory within the current path.

Alias: i

Options:

• -u, --update: If the core directory already exists, overwrite and update it to the latest version.

Examples:

# Initialize core for the first time
kimia init-core

# Update an existing core installation
kimia init-core -u

kimia dev-app

Automates the development environment setup for the current application. This command is intended to be run from inside an existing Kimia app directory (e.g., cd myapp).

What it does:

1. Checks if the current app is in advanced mode (using pnpm workspaces).
2. Ensures the core directory exists in the parent folder (../core). If not, it automatically downloads and initializes it.
3. Ensures the mini_account app exists in the parent folder (../mini_account). If not, it automatically downloads @kimia-framework/mini_account from npm, extracts it, and installs its dependencies.
4. Ensures a settings.json file exists in the parent folder with default multiple-app configurations. If not, it generates one.
5. Starts the development server by running pnpm run dev (for advanced mode) or npm run dev.

Example:

# Navigate to your app folder
cd path/to/projects/myapp

# Run the dev-app command
kimia dev-app

License

ISC