pasubot_quk v1.0.2

README.md

# pasubot_quk

`pasubot_quk` is a custom CLI tool designed to streamline the addition of React components to your project. You can use it to add individual components or all components associated with a specific project ID.

## Features

- Add individual components to your project.
- Add all components associated with a specific project ID.
- Prompts to confirm overwriting if a component already exists.
- View and update project configuration.

## Installation

To install `pasubot_quk`, you can use npm:

```bash
npm install -g pasubot_quk

Usage

Adding a Single Component

To add a single component to your project, use the add command followed by the component ID. For example, to add a Card component:

npx pasubot_quk add Card

This command will:

1. Fetch the Card component.
2. Add the Card component file to your project's components directory.
3. Add the Card component configuration file to your project's config directory.
4. Prompt you to confirm if the component already exists and handle accordingly.

Adding All Components for a Project

To add all components associated with a specific project ID, use the project command followed by the project ID. For example, to add all components for a project with ID your_project_id:

npx pasubot_quk project your_project_id

This command will:

1. Fetch all components associated with the specified project ID.
2. Add each component file to your project's components directory.
3. Add each component configuration file to your project's config directory.
4. Prompt you to confirm if any component already exists and handle accordingly.

Viewing Configuration

To view the current project configuration, use the config view command:

npx pasubot_quk config view

This command will display the current project name and API key.

Updating Configuration

To update the project configuration, use the config update command:

npx pasubot_quk config update

This command will prompt you to enter the project name and API key, updating the stored configuration.

Example Commands

• Add a single component:

  npx pasubot_quk add Alert

• Add all components for a project:

  npx pasubot_quk project my_project_id

• View configuration:

  npx pasubot_quk config view

• Update configuration:

  npx pasubot_quk config update

Notes

• Ensure your project has components and config directories to hold the respective files.
• The CLI tool will prompt you to confirm overwriting if a component file already exists in your project.
• The configuration commands allow you to view and update the project configuration, ensuring that there is only one project configuration per user.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue.

License

This project is licensed under the ISC License.

### Detailed Explanation:

1. **Installation Instructions**: Provides a command to globally install the CLI tool.
2. **Usage Instructions**:
   - **Adding a Single Component**: Explains the `add` command with an example.
   - **Adding All Components for a Project**: Explains the `project` command with an example.
   - **Viewing Configuration**: Explains the `config view` command.
   - **Updating Configuration**: Explains the `config update` command.
3. **Example Commands**: Clear examples for adding a single component, adding all components for a project, viewing configuration, and updating configuration.
4. **Notes**: Highlights important details about directory structure, confirmation prompts, and configuration management.
5. **Contributing**: Encourages contributions from other developers.
6. **License**: States the license under which the project is shared.