iconcraft-cli

IconCraft CLI

IconCraft CLI is a lightweight command-line application written in Go that allows you to explore and export icons from the Lucide icon database. With support for multiple frameworks, it simplifies the process of integrating beautifully designed icons into your projects.

Features

• 🔍 Search Icons: Quickly find icons by name or keyword.
• 📜 Explore Icons: Browse and view a list of matching icons.
• 📋 Export Options: Copy the icon's code in your desired format:
  • JSX
  • React
  • Angular
  • Vue
  • Svelte

Installation

Prerequisites

• Go 1.19 or later installed on your system.

Steps

1. Clone the repository:

   git clone https://github.com/yourusername/iconcraft-cli.git
   cd iconcraft-cli
   

2. Build the application:

   go build -o iconcraft-cli
   

3. (Optional) Move the executable to your PATH for global access:

   mv iconcraft-cli /usr/local/bin/
   

Usage

Run the application directly from your terminal:

./iconcraft-cli

Follow the on-screen prompts to search, browse, and export icons.

Example

$ ./iconcraft-cli
Welcome to IconCraft CLI - Your Go-To Tool for Lucide Icons!  
Effortlessly search and explore a vast database of icons from [Lucide](https://lucide.dev/).  

📂 **Features:**  
- 🔍 **Search:** Quickly find icons by name or keyword.  
- 📜 **Explore:** View the names of matching icons in an easy-to-read list.  
- 📋 **Export:** Copy your chosen icon's code in your preferred framework:  
  - JSX  
  - React  
  - Angular  
  - Vue  
  - Svelte  

Start now and supercharge your workflow with the perfect icon for your project!

License

This project is licensed under the MIT License. See the LICENSE file for details.

Third-Party Licenses

This project uses icons from Lucide, which are licensed under the ISC License.

Lucide License

ISC License

Copyright (c) for portions of Lucide are held by Cole Bemis 2013-2022 as part of Feather (MIT). All other copyright (c) for Lucide are held by Lucide Contributors 2022.

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Contributing

We welcome contributions! To contribute:

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes and push to your fork.
4. Submit a pull request.

Feedback and Support

For issues, suggestions, or feature requests, open an issue on the GitHub Issues page.

IconCraft CLI: Craft beautiful interfaces effortlessly with icons!