Getting Started
Learn how to install and configure the library in your project.
This guide will walk you through setting up the library in a new or existing project. The installation process takes about 5 minutes.
Installation
Install the package using your preferred package manager. We support npm, yarn, and pnpm.
npm install @example/libraryInfo: Make sure you have Node.js 18 or later installed before proceeding.
Configuration
After installation, you need to create a configuration file. This file controls the behavior of the library.
Configuration Options
- theme - The visual theme to use (default, dark, or custom)
- plugins - Array of plugins to enable
- output - Directory for generated files
- verbose - Enable detailed logging (optional)
Tip: You can also use a .configrc file or add a config key to your package.json.
Verification
To verify your installation is working correctly, run the following command. It should output the installed version.
npx example-cli --versionWarning: If you see a permissions error, you may need to run with elevated privileges or check your Node.js installation.
Next Steps
Now that you have the library installed and configured, you're ready to start building. Check out the Basic Usage guide to learn about core concepts.