@pawcode/cli
v0.0.12
Published
Paw Cli
Downloads
21
Readme
PawCode CLI
PawCode CLI is a Command-Line Interface tool designed to streamline the creation and management of Paw projects, a lightweight frontend framework. With a simple set of commands, users can quickly set up a new Paw project, complete with essential files and configurations.
Features
- Easy Project Creation: Quickly scaffold a new Paw project with a simple command.
- Verbose Output: Option to display additional messages during the execution for detailed feedback.
- Automated Git Operations: Automatically clones the necessary repository to set up the project structure.
Installation
To install Paw CLI, you need to have Node.js and npm installed on your machine. Once these prerequisites are met, install Paw CLI globally using npm:
npm install -g @pawcode/cli
Usage
Creating a New Project
To create a new Paw project, use the create
command followed by the name of your project:
paw create <projectName>
This will create a new directory named my-paw-project and set up the initial project structure.
Verbose Mode
If you need more detailed output during the creation process, use the --verbose option:
paw create <projectName> --verbose
Checking the Installed Version
To check the version of Paw CLI installed on your system, use:
paw --version
Troubleshooting
If you encounter any issues:
- Ensure you have the latest version of Node.js and npm installed.
- Check if Git is installed, as it's required for the cloning process.
- For detailed error messages, use the
--verbose
option.
Contributing
Contributions to Paw CLI are welcome. Please refer to the project's repository for contribution guidelines.
License
Paw CLI is open-source software, released under the MIT License.