https://github.com/pranavh-2004/linklens
LinkLens is a CLI tool for efficiently checking the status of multiple links, both sequentially and asynchronously, with detailed error handling.
https://github.com/pranavh-2004/linklens
asynchronous cli link-checker nim nimble synchronous url-validation
Last synced: 6 months ago
JSON representation
LinkLens is a CLI tool for efficiently checking the status of multiple links, both sequentially and asynchronously, with detailed error handling.
- Host: GitHub
- URL: https://github.com/pranavh-2004/linklens
- Owner: Pranavh-2004
- License: mit
- Created: 2025-01-02T06:35:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-05T14:02:23.000Z (over 1 year ago)
- Last Synced: 2025-01-28T19:21:16.378Z (over 1 year ago)
- Topics: asynchronous, cli, link-checker, nim, nimble, synchronous, url-validation
- Language: Nim
- Homepage:
- Size: 369 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# LinkLens
**LinkLens** is a command-line tool for checking the validity of links in a file. It allows you to verify links sequentially or asynchronously, making it fast and efficient for processing large sets of URLs.
## Features
- **Sequential Link Checking**: Check each link one by one.
- **Asynchronous Link Checking**: Check multiple links concurrently for faster performance.
- **Error Handling**: Handles various HTTP errors and connection issues, providing detailed feedback on why a link may be invalid.
## Installation
To install LinkLens, you'll need [Nim](https://nim-lang.org/) and [Nimble](https://nim-lang.org/docs/nimble.html) (Nim's package manager). Follow these steps:
1. **Install Nim**:
If you don't have Nim installed, you can install it by following the instructions on the [official Nim website](https://nim-lang.org/).
2. **Clone the repository**:
```bash
git clone https://github.com/yourusername/LinkLens.git
cd LinkLens
```
3. **Install dependencies:**
LinkLens uses the nimble package manager to handle dependencies. Run the following command to install the required libraries:
```bash
nimble install
```
4. **Build the application:**
Once installed, build the application by running:
```bash
nimble build
```
## Usage
To use LinkLens, simply run the following command:
```bash
nimble run --
```
### Example
Create a links.txt file with the following content:
```
https://www.example.com
https://www.nonexistentwebsite.com
```
Then, run the following command:
```bash
nimble run -- examples/links.txt
```
## Contributing
If you want to contribute to the project, feel free to open a pull request or submit issues.
### Steps to Contribute:
1. Fork the repository.
2. Create a feature branch.
3. Make changes and commit them.
4. Open a pull request with a clear description of what was changed.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.