CLI
Use the CLI to add components to your project.
init
Use the init command to initialize dependencies for a new project.
The init command installs dependencies, adds the cn util, configures tailwind.config.cjs, and creates CSS variables for the project.
npx svell@latest init
You will be asked a few questions to configure components.json:
Which style would you like to use? › Default
Which color would you like to use as base color? › Slate
Where is your global CSS file? › src/app.pcss
Where is your tailwind.config.[cjs|js|ts] located? › tailwind.config.js
Configure the import alias for components: › $lib/components
Configure the import alias for utils: › $lib/utils
Options
Usage: svell init [options]
initialize your project and install dependencies
Options:
-y, --yes skip confirmation prompt. (default: false)
-c, --cwd <cwd> the working directory. (default: the current directory)
-h, --help display help for command
add
Use the add command to add components and dependencies to your project.
npx svell@latest add [component]
You will be presented with a list of components to choose from:
Which components would you like to add? › Space to select. Return to submit.
◯ accordion
◯ alert
◯ alert-dialog
◯ aspect-ratio
◯ avatar
◯ badge
◯ button
◯ card
◯ checkbox
◯ collapsible
Options
Usage: svell add [options] [components...]
add components to your project
Arguments:
components name of components
Options:
--nodep disable adding & installing dependencies (advanced) (default: false)
-a, --all Add all components to your project. (default: false)
-y, --yes Skip confirmation prompt. (default: false)
-o, --overwrite overwrite existing files. (default: false)
--proxy fetch components from registry using a proxy.
-c, --cwd <cwd> the working directory. (default: the current directory)
-p, --path <path> the path to add the component to.
-h, --help display help for command
update
Use the update command to update components in your project. This will overwrite any modifications you've made to the components, so be sure to commit your changes before running this command.
npx svell@latest update [component]
Options
Usage: svell update [options] [components...]
update components in your project
Arguments:
components name of components
Options:
-a, --all update all existing components. (default: false)
-c, --cwd <cwd> the working directory. (default: the current directory)
-h, --help display help for command
Outgoing Requests
proxy
A proxy to use for outgoing request to fetch from shadcn registry. If HTTP_PROXY or http_proxy environment variables are set, the underlying request library will honor proxy settings.
On This Page