{"id":24637821,"url":"https://github.com/tantelyrandriamazaoro/charbon-cli","last_synced_at":"2026-02-27T17:05:10.740Z","repository":{"id":271359953,"uuid":"912871321","full_name":"TantelyRandriamazaoro/charbon-cli","owner":"TantelyRandriamazaoro","description":"A Command Line Interface to automate/assist the job search and application process. ","archived":false,"fork":false,"pushed_at":"2025-02-04T14:50:58.000Z","size":258,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-04T15:43:08.362Z","etag":null,"topics":["automations","dependency-injection","google-custom-search-api","nodejs","object-oriented-programming","openai-api","puppeteer","sqlite","typescript","web-scraping"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TantelyRandriamazaoro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-06T15:08:00.000Z","updated_at":"2025-01-26T07:19:58.000Z","dependencies_parsed_at":"2025-01-07T08:48:08.079Z","dependency_job_id":"f69ca55e-6f60-4732-9770-1278e1914ad0","html_url":"https://github.com/TantelyRandriamazaoro/charbon-cli","commit_stats":null,"previous_names":["tantelyrandriamazaoro/charbon-cli"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TantelyRandriamazaoro%2Fcharbon-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TantelyRandriamazaoro%2Fcharbon-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TantelyRandriamazaoro%2Fcharbon-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TantelyRandriamazaoro%2Fcharbon-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TantelyRandriamazaoro","download_url":"https://codeload.github.com/TantelyRandriamazaoro/charbon-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244584326,"owners_count":20476522,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automations","dependency-injection","google-custom-search-api","nodejs","object-oriented-programming","openai-api","puppeteer","sqlite","typescript","web-scraping"],"created_at":"2025-01-25T10:12:03.172Z","updated_at":"2026-02-27T17:05:10.698Z","avatar_url":"https://github.com/TantelyRandriamazaoro.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 Charbon CLI 🔍\n\nCharbon CLI is your ultimate Command Line Interface to streamline the job search and application process! 🎯 It provides powerful tools to automate and optimize your job-hunting workflow, so you can focus on landing your dream job! 💼✨\n\n## 🎨 Features\n\nCharbon CLI supports a 10-batch stage FIFO queue style and a live one-to-one feature with the following commands:\n\n### 🔎 `charbon search \u003cquery\u003e`\n- **Description**: Uses Google Custom Search JSON API to search for jobs on job boards.\n- **Current Support**: Supports \"Lever.co\" (with plans to support other boards).\n- **Functionality**:\n  - Associates search results with a tagged resume for use in the `charbon apply` command.\n  - Allows specific keywords with the `--keywords` option and filters by job boards using the `--board` option (default: \"lever\").\n  - Enables location-based filtering with the `--country` option (default: \"us\").\n  - Stores jobs in a database and marks them with a status of \"Discovered.\"\n- **Database Support**: Supports multiple paradigms; currently uses an SQLite adapter (MVP).\n\n### 🕵️ `charbon scrape`\n- **Description**: Uses Puppeteer to scrape job descriptions and custom questions.\n- **Functionality**:\n  - Processes job descriptions using OpenAI's GPT-4o API to extract structured JSON data.\n  - Stores extracted data in the database with a status of \"Scraped.\"\n\n### 🧐 `charbon review`\n- **Description**: Fetches all \"Scraped\" jobs for manual review.\n- **Functionality**:\n  - Allows users to flag jobs as \"Not Interested\" or \"Not Qualified.\"\n  - Marks suitable jobs as \"Reviewed\" to prepare for the next stage.\n\n### 🛠️ `charbon prepare`\n- **Description**: Fetches all \"Reviewed\" jobs and processes custom questions.\n- **Functionality**:\n  - Uses OpenAI's GPT-4o API and a user-provided knowledge base to generate answers to custom questions.\n  - Stores these answers and updates the job status to \"Prepared.\"\n\n### 🤖 `charbon apply`\n- **Description**: Automates the application process.\n- **Functionality**:\n  - Uses Puppeteer to open a Chrome browser and auto-apply using the tagged resume and custom answers.\n  - Allows manual user review of answers with the option to regenerate responses.\n  - Marks jobs as \"Applied\" upon completion.\n\n### ⚡ `charbon live`\n- **Description**: Consolidates all processes except `charbon search`.\n- **Functionality**:\n  - Processes jobs one by one for fine-grained control.\n\n## 🛠️ Installation\n\nThis project is not yet published on npm and requires cloning or forking the repository to use. Users must manually set up the environment.\n\n### Prerequisites\n- A \"data\" folder containing:\n  - `db.sqlite` (SQLite database file).\n  - `knowledge.txt` (knowledge base file).\n- Google Custom Search JSON API key.\n- OpenAI account with available credits.\n\n### Steps:\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/TantelyRandriamazaoro/charbon-cli.git\n   ```\n2. Navigate to the project directory:\n   ```bash\n   cd charbon-cli\n   ```\n3. Install the dependencies:\n   ```bash\n   npm install\n   ```\n4. Set up the environment variables:\n   ```bash\n   cp .env.template .env\n   ```\n5. Edit the `.env` file with your API keys and other credentials.\n6. build the project:\n   ```bash\n   npm run build\n   ```\n7. Link the project to your system:\n   ```bash\n    npm link\n    ```\n8. Run the CLI:\n    ```bash\n    charbon --help\n    ```\n9. Follow the instructions to use the CLI.\n\n## 🔧 Usage\n\nRun the following command for help:\n\n```bash\ncharbon --help\n```\n\n### 🗂️ Example Workflow\n\n1. Search for jobs:\n   ```bash\n   charbon search \"Software Engineer\" --keywords \"remote, full-time\" --board \"lever\" --country \"us\"\n   ```\n2. Scrape job details:\n   ```bash\n   charbon scrape\n   ```\n3. Review scraped jobs:\n   ```bash\n   charbon review\n   ```\n4. Prepare applications:\n   ```bash\n   charbon prepare\n   ```\n5. Apply to jobs:\n   ```bash\n   charbon apply\n   ```\n6. Use live mode for manual control:\n   ```bash\n   charbon live\n   ```\n\n## 🚧 Roadmap\n\nCharbon CLI is an MVP aimed at quickly delivering results rather than achieving perfection. Here's a roadmap for the next set of features:\n\n1. **Publish as a Global npm Package**:\n   - Make Charbon CLI globally installable for easier access.\n\n2. **Add a GUI with Nuxt.js**:\n   - Develop a user-friendly graphical interface for those who prefer a visual workflow.\n\n3. **Backend Development**:\n   - Create a backend using Python or Nest.js.\n   - Implement user authentication and monetization features.\n\n4. **Configuration Management**:\n   - Integrate Terraform for managing infrastructure configurations.\n\n5. **CI/CD Pipelines**:\n   - Establish continuous integration and deployment pipelines for streamlined updates.\n\n6. **Containerization**:\n   - Launch the front-end and back-end in containers for scalability and portability.\n\n7. **CLI Integration with Backend**:\n   - Enable the CLI to be programmatically used as part of the backend application.\n\n## 🤝 Contributing\n\nWe welcome contributions! Please fork the repository and create a pull request. See the original README for detailed contribution steps.\n\n## 📜 License\n\nCharbon CLI is licensed under the [MIT License](LICENSE).\n\n## 🙋 Support\n\nFor demos or inquiries, contact me by email. Additional support can be obtained by opening an issue on GitHub.\n\n## 💡 Acknowledgments\n\nThanks to the open-source community and contributors for inspiration and support in building Charbon CLI.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftantelyrandriamazaoro%2Fcharbon-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftantelyrandriamazaoro%2Fcharbon-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftantelyrandriamazaoro%2Fcharbon-cli/lists"}