Command Line Interface

yaoxiang init

Initialize a new YaoXiang project.

Usage

yaoxiang init <project-name>

Arguments

Argument	Description
project-name	Name of the new project

Options

Option	Description
--help	Display help information

Examples

# Create a new project
yaoxiang init my-project

# Result:
# ✨ Project created: my-project
#   my-project/yaoxiang.toml
#   my-project/yaoxiang.lock
#   my-project/src/main.yx
#   my-project/.gitignore

---

yaoxiang add

Add dependencies to the project.

Usage

yaoxiang add <package-name> [version]
yaoxiang add <package-name> --dev

Arguments

Argument	Description
package-name	Name of the dependency to add
version	Version number (optional, defaults to *)

Options

Option	Description
--dev, -D	Add as dev dependency

Examples

# Add latest version
yaoxiang add http

# Add specific version
yaoxiang add http 1.0.0

# Add version range
yaoxiang add json ">=2.0.0"

# Add dev dependency
yaoxiang add test-utils --dev
yaoxiang add benchmark -D

---

yaoxiang rm

Remove dependencies from the project.

Usage

yaoxiang rm <package-name>
yaoxiang rm <package-name> --dev

Arguments

Argument	Description
package-name	Name of the dependency to remove

Options

Option	Description
--dev, -D	Remove dev dependency

Examples

# Remove regular dependency
yaoxiang rm http

# Remove dev dependency
yaoxiang rm test-utils --dev

---

yaoxiang install

Install project dependencies.

Usage

yaoxiang install

Description

• Reads dependency declarations from yaoxiang.toml
• Downloads all dependencies to vendor directory
• Generates/updates yaoxiang.lock with locked versions
• Detects dependency version conflicts

Examples

# Install all dependencies
yaoxiang install

# Example output:
# 📦 Resolving dependencies...
#   http (1.0.0) [installed]
#   json (2.0.0) [cached]
# ✅ Dependencies installed, lock file updated

---

yaoxiang update

Update project dependencies.

Usage

yaoxiang update
yaoxiang update <package-name>

Arguments

Argument	Description
package-name	Specific dependency to update (optional)

Description

• Without argument: Update all dependencies
• With argument: Update only the specified dependency

Examples

# Update all dependencies
yaoxiang update

# Example output:
# 📦 Updating dependencies...
#   http (0 → 1.1.0)
# ✅ 1 dependency updated, lock file updated

# Update single dependency
yaoxiang update http

---

yaoxiang list

List all dependencies of the project.

Usage

yaoxiang list

Description

Displays all runtime dependencies and development dependencies, along with their versions and sources.

Examples

# List dependencies
yaoxiang list

# Example output:
# 📦 Project Dependencies
#
# Runtime dependencies:
#   http        1.0.0    registry
#   json        2.0.0    registry
#
# Development dependencies:
#   test-utils  0.5.0    registry