https://github.com/ajiwo/resumatter
Open source AI tool for tailoring resumes to specific job descriptions. Includes accuracy validation and job posting analysis.
https://github.com/ajiwo/resumatter
ai api backend cli-tool gemini go resume self-hosted
Last synced: 5 months ago
JSON representation
Open source AI tool for tailoring resumes to specific job descriptions. Includes accuracy validation and job posting analysis.
- Host: GitHub
- URL: https://github.com/ajiwo/resumatter
- Owner: ajiwo
- License: apache-2.0
- Created: 2025-07-29T16:23:35.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-10-26T10:27:21.000Z (8 months ago)
- Last Synced: 2025-10-26T12:22:41.371Z (8 months ago)
- Language: Go
- Size: 1.06 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Resumatter
> [!WARNING]
> This project is in the early stages of development and should be considered beta software. APIs and configurations may change.
Resumatter is an AI-powered resume tailoring tool designed to optimize your resume for any job description. It leverages Generative AI to analyze your resume and a target job posting, then rewrites your resume to maximize its impact and improve its Applicant Tracking System (ATS) score.
## Core Features
- **AI-Powered Resume Tailoring**: Integrates with multiple AI providers (Google Gemini, OpenAI) to help rewrite and optimize resume content.
- **ATS Scoring & Analysis**: Offers estimated ATS scoring and analysis, highlighting potential strengths and areas for improvement based on job descriptions.
- **Resume Integrity Evaluation**: Compares tailored resumes against originals to help ensure important information is preserved.
- **REST API**: Provides functionality through a versioned REST API for integration with other tools.
- **Flexible Configuration**: Configurable via YAML files with validation, environment variable support, and variable expansion.
- **Observability Support**: Includes OpenTelemetry integration for metrics and tracing to help with monitoring and debugging.
## API Endpoints
Resumatter exposes the following core endpoints:
- `POST /api/v1/ai/tailor`: Takes a base resume and a job description, and returns a tailored resume along with an ATS analysis.
- `POST /api/v1/ai/evaluate`: Compares a base resume and a tailored resume to check for significant data loss or hallucinated additions.
- `POST /api/v1/ai/analyze`: Takes a job description and returns a detailed analysis of its quality, clarity, inclusivity, and market competitiveness.
- `GET /health`: A simple health check endpoint.
## Getting Started
### 1. Build the Application
```bash
make build
```
This command compiles the main `resumatter` server binary into the `./build` directory.
### 2. Configure the Application
You have two options for configuration:
#### Option A: Using Environment Variables (Recommended for quick start)
Set the required environment variable and run directly:
```bash
export AI_GEMINI_API_KEY="your-gemini-api-key"
./build/resumatter serve
```
#### Option B: Using Configuration File
Copy `config.getting-started.yaml` to `config.yaml` and populate it with your settings:
```bash
cp config.getting-started.yaml config.yaml
# Edit config.yaml with your API keys and settings
./build/resumatter serve
```
### 3. Run the Server
```bash
./build/resumatter serve
```
The server will start, typically on port 8780, as defined in your configuration.
By default, config file watching is enabled and TLS certificate file watching is enabled. Configuration changes are automatically applied where possible:
- **Rate limiting**: Fully hot-reloadable
- **AI provider settings**: Fully hot-reloadable
- **Authentication settings**: Fully hot-reloadable
- **TLS certificates**: Automatically reloaded when `server.pem` or `server-key.pem` files change
- **TLS settings** (`min_version`, `cipher_suites`, `mode`): Require a server restart
You can control this behavior with flags:
```bash
# Enable config file watching
./build/resumatter serve --config-watch
# Disable TLS certificate file watching
./build/resumatter serve --tls-cert-watch=false
```
### 4. Use the API
You can interact with the API using `curl` or any HTTP client. The `scripts` directory contains example usage scripts.
**Example: Tailor a Resume**
```bash
./scripts/test-tailor.sh
```
## Configuration Management
While the main application is a server, it includes a CLI for managing its configuration.
### Validate Configuration
```bash
./build/resumatter validate --verbose
```
Validates the configuration file and reports any errors. With `--verbose`, shows summary statistics.
### Show Complete Configuration
```bash
./build/resumatter show
```
Displays the entire parsed configuration in JSON format.
### List & Show AI Presets
```bash
# List all available presets
./build/resumatter list-presets
# Show details for a specific preset
./build/resumatter show-preset prod-gemini
```
## Configuration Options
### Quick Start with Environment Variables
The application can run without a configuration file - just set your API key:
```bash
export AI_GEMINI_API_KEY="your-gemini-api-key"
./build/resumatter serve
```
### Configuration File Support
For advanced configuration, use a YAML file:
```bash
cp config.getting-started.yaml config.yaml
# Edit with your settings
./build/resumatter serve
```
Configuration files support environment variable expansion for sensitive data:
```yaml
ai:
presets:
default:
api_key: "${GEMINI_API_KEY}"
```
## Contributing
Contributions are welcome! Please note that this project is maintained in my spare time, so my availability may be limited to a couple of times a week. I appreciate your patience and understanding.
If you'd like to contribute, please:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with clear, descriptive messages.
4. Open a pull request, and I will review it as soon as I can.
## License
This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.