https://github.com/nalmeida/urltracker
A command-line tool to check HTTP status codes and track redirections for URLs.
https://github.com/nalmeida/urltracker
cli curl http httpx
Last synced: 11 days ago
JSON representation
A command-line tool to check HTTP status codes and track redirections for URLs.
- Host: GitHub
- URL: https://github.com/nalmeida/urltracker
- Owner: nalmeida
- License: mit
- Created: 2025-04-10T20:35:17.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-04-30T20:41:16.000Z (23 days ago)
- Last Synced: 2025-04-30T21:36:51.282Z (23 days ago)
- Topics: cli, curl, http, httpx
- Language: Shell
- Homepage: https://nalmeida.github.io/urltracker/
- Size: 302 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# URL Tracker
> A command-line tool to check HTTP status codes and track redirections for URLs.
Github repo: [https://github.com/nalmeida/urltracker](https://github.com/nalmeida/urltracker)
## Overview
URL Tracker helps you analyze HTTP responses and redirects for single URLs or lists of URLs. Perfect for website maintenance, SEO auditing, and link checking.
### Features:
- Single URL status checking
- Batch URL processing from a file
- Redirect chain tracking
- CSV output for further analysis
- Basic authentication support
- Custom headers and cookies
## Prerequisites
- Bash shell environment
- `curl` command-line tool
- `BATS` (Bash Automated Testing System) for running tests
## Installation
### Via Homebrew
```bash
brew tap nalmeida/urltracker
brew install urltracker
```
> [!NOTE]
> [URL Tracker Homebrew Formula](https://github.com/nalmeida/urltracker)
### Via git clone
1. Clone this repository:
```bash
git clone https://github.com/nalmeida/urltracker.git
cd urltracker
```
2. Make the script executable:
```bash
chmod +x urltracker
```
3. (Optional) Create a symlink to use it from anywhere:
```bash
sudo ln -s $(pwd)/urltracker /usr/local/bin/urltracker
```
## Usage
### Basic URL Check
```bash
urltracker https://httpbin.org/status/200
```
### Process a List of URLs
Create a text file with one URL per line:
```
https://httpbin.org/status/200
https://httpbin.org/redirect/2
https://httpbin.org/status/404
```
Then run:
```bash
urltracker --list urls.txt
```
### Output to CSV
```bash
urltracker --list urls.txt --output results.csv
```
### Using Authentication
```bash
urltracker --auth user:pass https://httpbin.org/basic-auth/user/pass
```
### Using Custom Headers
```bash
urltracker --header "User-Agent: Mozilla/5.0" --header "Accept-Language: en-US" https://httpbin.org/status/200
```
### Verbose Output
```bash
urltracker --verbose https://httpbin.org/redirect/2
```
### Full Options List
```
Usage: urltracker [OPTIONS] [URL]
Options:
-h, --help Display this help message
-V, --version Display the version
-l, --list Process a list of URLs from a text file
-o, --output Export results to a CSV file
-v, --verbose Verbose mode: show all redirect URLs
-q, --quiet Quiet mode: no output to console
-nc, --no-color Disable colored output
-a, --auth Use HTTP Basic Authentication
-H, --header Add custom header (can be used multiple times)
-c, --cookie Add a cookie (can be used multiple times)
```
## Development
### Running Tests
This project uses BATS (Bash Automated Testing System) for testing. To run the tests:
1. Install BATS if you don't have it:
```bash
# MacOS
brew install bats-core
# Debian/Ubuntu
sudo apt-get install bats
```
2. Run the tests:
```bash
bats test_urltracker.bats
```
3. For verbose test output:
```bash
bats --tap test_urltracker.bats
```
4. For debug test output:
```bash
bats --print-output-on-failure --show-output-of-passing-tests test_urltracker.bats
```
### Test Coverage
The test suite covers:
- Basic functionality
- URL list processing
- Output formatting
- Error handling
- Authentication and custom headers
- Command-line option parsing
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes and add tests for new functionality
4. Run the test suite to ensure everything passes (`bats test_urltracker.bats`)
5. Commit your changes (`git commit -am 'Add amazing feature'`)
6. Push to the branch (`git push origin feature/amazing-feature`)
7. Create a new Pull Request
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Acknowledgments
- The [BATS project](https://github.com/bats-core/bats-core) for the testing framework
- The command `curl -IL https://httpbin.org/redirect/2` that led me to create this project
- The amazing [httpx](https://github.com/projectdiscovery/httpx) as inspiration and a powerful alternative to this humble project
- The amazing [vhs](https://github.com/charmbracelet/vhs) CLI demo generator