Getting Started

Prerequisites##

• Operating systems: macOS, Linux, or Windows (WSL is recommended for Windows).
• Node.js, Bun, or Yarn installed.
• System PATH points to the global package installation location.

Installation##

Install Lokio CLI globally using one of the following package managers:

Bun##

bun add -g lokio

npm##

npm install -g lokio

Yarn##

yarn global add lokio

Notes:

• If you're behind a proxy, ensure HTTP_PROXY/HTTPS_PROXY are configured.
• Consider setting a global prefix to avoid requiring sudo.

Verification##

Display the version to verify the installation:

lokio --version

Project Compatibility##

Lokio CLI can be used with various types of projects:

• Golang
• Next.js
• Vue
• Rust
• Hono
• And more

Navigate into your project directory, then run Lokio commands.

Project Initialization##

Navigate into your project directory and run:

cd /path/to/your-project
lokio init

The following structure will be created:

project/
├── lokio.yaml              # Project configuration
└── lokio/
    ├── configs.yaml        # Template registry
    └── templates/          # Template files directory
        └── example.lokio   # Example template

Structure Explanation##

• lokio.yaml
  Project-level configuration for team work patterns (project name, conventions, template references).
• lokio/configs.yaml
  Catalog of templates and rules used across the team.
• lokio/templates/
  Directory containing Lokio template files; use example.lokio as an initial reference.