@skroyc/librarian 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,176 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-01-15
+
+### Added
+
+- **Core CLI Functionality**
+  - Initial CLI implementation with Commander.js for command parsing
+  - `explore` command for technology research with support for `--tech` and `--group` options
+  - `list` command to display available technologies with filtering by group
+  - Comprehensive help system with `-h` and `--help` flags
+
+- **Agent System**
+  - LangChain-powered ReAct agent implementation for intelligent codebase exploration
+  - Dynamic system prompt construction based on selected technology/group context
+  - Sandboxed tool execution within isolated working directories
+  - Memory management using LangGraph with MemorySaver checkpointing
+
+- **Repository Management**
+  - Auto-clone repositories from Git before each query
+  - Auto-update repositories with git pull before exploration
+  - Branch support with automatic fallback to main/master
+  - Organized storage structure: `{repos_path}/{group}/{technology}`
+
+- **Tool Suite**
+  - `File Listing Tool`: List files and directories within sandboxed working directory
+  - `File Reading Tool`: Read file contents with support for various file types
+  - `Grep Search Tool`: Search file contents using regex patterns
+  - `Glob Search Tool`: Find files by name patterns using glob syntax
+
+- **LLM Provider Support**
+  - Unified model abstraction through LangChain's `initChatModel`
+  - OpenAI integration via `@langchain/openai`
+  - Anthropic integration via `@langchain/anthropic`
+  - Google GenAI integration via `@langchain/google-genai`
+  - OpenAI-compatible provider support
+  - Anthropic-compatible provider support
+  - CLI-based providers: Claude Code and Gemini CLI
+  - Built-in OpenCode Zen integration (no API key required by default)
+
+- **Configuration System**
+  - YAML-based configuration file support
+  - Configuration validation using Zod schemas
+  - Environment variable support via `.env` files
+  - Path expansion and normalization
+  - Backward compatibility with legacy configuration keys
+
+- **Security Features**
+  - Path validation preventing directory traversal attacks
+  - Sandboxed working directory isolation for all tools
+  - Absolute path validation to prevent escape attempts
+  - Security verification script for testing sandboxing
+
+- **Logging System**
+  - Comprehensive logging with timestamped log files
+  - Sensitive information redaction (API keys, paths, URLs)
+  - Multiple log levels: INFO, DEBUG, WARN, ERROR
+  - Performance timing measurements
+  - Silent file logging with no impact on stdout
+
+### Changed
+
+- **Architecture**
+  - Modular structure separating CLI, core logic, agents, tools, and utilities
+  - TypeScript-first development with strict type checking
+  - ES module system with proper exports configuration
+  - Source map generation for better debugging experience
+
+### Dependencies
+
+- **Core Runtime**
+  - `commander`: ^14.0.2 (CLI argument parsing)
+  - `yaml`: ^2.8.2 (Configuration parsing)
+  - `isomorphic-git`: ^1.36.1 (Git operations)
+  - `zod`: ^4.2.1 (Runtime validation)
+
+- **Agent Framework**
+  - `langchain`: ^1.2.2 (Core LangChain framework)
+  - `@langchain/langgraph`: ^1.0.7 (State management)
+  - `@langchain/openai`: ^1.2.0 (OpenAI integration)
+  - `@langchain/anthropic`: ^1.3.2 (Anthropic integration)
+  - `@langchain/google-genai`: ^2.1.2 (Google integration)
+
+- **Development Tools**
+  - `typescript`: ^5.9.3
+  - `@biomejs/biome`: ^2.3.11
+  - `eslint`: ^9.39.2
+
+### Features by Category
+
+#### Repository Management
+- Auto-clone repositories on first access
+- Auto-update before each query
+- Custom repository path configuration
+- Branch specification support
+- Organized group/technology hierarchy
+
+#### Agent Capabilities
+- Intelligent codebase exploration
+- Context-aware prompts
+- Streaming responses
+- Memory persistence across sessions
+- Tool execution sandboxing
+
+#### CLI Experience
+- Interactive command parsing
+- Colored output support
+- Error handling with appropriate exit codes
+- Configuration validation feedback
+- Help text generation
+
+#### Multi-Provider Support
+- Zero-configuration OpenCode Zen integration
+- OpenAI API key support
+- Anthropic API key support
+- Google API key support
+- Custom OpenAI-compatible endpoints
+- Claude CLI integration
+- Gemini CLI integration
+
+### Security
+
+- Input validation on all configuration parameters
+- Path traversal prevention
+- Sandboxed file system access
+- API key protection through environment variables
+- Comprehensive logging without sensitive data exposure
+
+### Installation Methods
+
+- **NPM**: `@skroyc/librarian`
+- **Bun**: `@skroyc/librarian`
+- **Nix**: `nix run github:SkrOYC/librarian`
+- **Source**: Manual build from GitHub repository
+
+### System Requirements
+
+- **Node.js**: >= 18.0.0
+- **Bun**: >= 1.0.0
+- **Git**: Any recent version with HTTPS/SSH support
+- **Platform**: Cross-platform (Linux, macOS, Windows with WSL)
+
+### Known Limitations
+
+- Initial release (v0.1.0) - first public version
+- Limited to Git-based repositories
+- Requires network access for repository cloning
+- LLM API calls require internet connectivity (except OpenCode Zen)
+
+### Roadmap
+
+Future versions will include:
+- Support for other VCS systems (Mercurial, Subversion)
+- Local caching optimization
+- Additional LLM providers
+- Plugin system for custom tools
+- Web-based dashboard for configuration management
+- Batch processing capabilities
+- Export formats for research results
+
+### Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+### License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+---
+
+**Full Changelog**: https://github.com/SkrOYC/librarian/compare/v0.1.0

package/LICENSE

@@ -0,0 +1,210 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which
+      the editorial revisions, annotations, elaborations, or other
+      modifications represent, as a whole, an original work of
+      authorship. For the purposes of this License, Derivative Works
+      shall not include works that remain separable from, or merely
+      link (or bind by name) to the interfaces of, the Work and
+      Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the
+      copyright owner or by an individual or Legal Entity authorized
+      to submit on behalf of the copyright owner. For the purposes of
+      this definition, "submitted" means any form of electronic,
+      verbal, or written communication sent to the Licensor or its
+      representatives, including but not limited to communication on
+      electronic mailing lists, source code control systems, and issue
+      tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work,
+      but excluding communication that is conspicuously marked or
+      otherwise designated in writing by the copyright owner as "Not
+      a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal
+      Entity on behalf of whom a Contribution has been received by
+      Licensor and subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions
+      of this License, each Contributor hereby grants to You a
+      perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+      irrevocable copyright license to reproduce, prepare Derivative
+      Works of, publicly display, publicly perform, sublicense, and
+      distribute the Work and such Derivative Works in Source or
+      Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have
+      made, use, offer to sell, sell, import, and otherwise transfer
+      the Work, where such license applies only to those patent claims
+      licensable by such Contributor that are necessarily infringed
+      by their Contribution(s) alone or by combination of their
+      Contribution(s) with the Work to which such Contribution(s) was
+      submitted. If You institute patent litigation against any entity
+      (including a cross-claim or counterclaim in a lawsuit) alleging
+      that the Work or a Contribution incorporated within the Work
+      constitutes direct or contributory patent infringement, then any
+      patent licenses granted to You under this License for that Work
+      shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute
+          must include a readable copy of the attribution notices
+          contained within such NOTICE file, excluding those notices
+          that do not pertain to any part of the Derivative Works, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within the
+          Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the
+          License.
+
+      You may add Your own copyright statement to Your modifications
+      and may provide additional or different license terms and
+      conditions for use, reproduction, or distribution of Your
+      modifications, or for any such Derivative Works as a whole,
+      provided Your use, reproduction, and distribution of the Work
+      otherwise complies with the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state
+      otherwise, any Contribution intentionally submitted for inclusion
+      in the Work by You to the Licensor shall be under the terms and
+      conditions of this License, without any additional terms or
+      conditions. Notwithstanding the above, nothing herein shall
+      supersede or modify the terms of any separate license agreement
+      you may have executed with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the
+      trade names, trademarks, service marks, or product names of the
+      Licensor, except as required for reasonable and customary use in
+      describing the origin of the Work and reproducing the content of
+      the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or
+      conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
+      FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible
+      for determining the appropriateness of using or redistributing
+      the Work and assume any risks associated with Your exercise of
+      permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and
+      grossly negligent acts) or agreed to in writing, shall any
+      Contributor be liable to You for damages, including any direct,
+      indirect, special, incidental, or consequential damages of any
+      character arising as a result of this License or out of the use
+      or inability to use the Work (including but not limited to
+      damages for loss of goodwill, work stoppage, computer failure or
+      malfunction, or any and all other commercial damages or losses),
+      even if such Contributor has been advised of the possibility of
+      such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with
+      this License. However, in accepting such obligations, You may
+      act only on Your own behalf and on Your sole responsibility,
+      not on behalf of any other Contributor, and only if You agree
+      to indemnify, defend, and hold each Contributor harmless for
+      any liability incurred by, or claims asserted against, such
+      Contributor by reason of your accepting any such warranty or
+      additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2026] [SkrOYC]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied.  See the License for the specific language governing
+   permissions and limitations under the License.