milady

(โ˜… 357)

terminally online

  • .biomeignore
  • .dependency-cruiser.cjs
  • .env.example
  • .gitattributes
  • .gitignore
  • .gitleaks.toml
  • .mcp.json
  • .npmignore
  • .nvmrc
  • .windsurfrules
  • AGENTS.md
  • biome.json
  • bun.lock
  • CLAUDE.md
  • install
  • install.cmd
  • install.ps1
  • install.sh
  • knip.jsonc
  • LICENSE
  • milady.mjs
  • package.json
  • plugins.json
  • README.md
  • tsconfig.json
  • tsconfig.workspace.json
  • tsdown.config.mjs
  • vitest.config.ts

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/milady-ai/milady

Downloads the entire project code from GitHub to your computer.

cd milady

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
  • Homebrew A package manager for macOS/Linux.
curl -fsSL https://get.milady.ai | bash

Downloads and runs the official install script in one line โ€” this handles the full setup automatically.

irm https://get.milady.ai/install.ps1 | iex

Downloads and runs the official install script via PowerShell โ€” this handles the full setup automatically.

npm install -g miladyai

Installs the package published on the npm registry globally โ€” no need to clone the source.

brew tap milady-ai/tap

Registers this project's repository (tap) with Homebrew.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g miladyai

Installs the package published on the npm registry globally โ€” no need to clone the source.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation