Merge pull request #1 from Sewer56/impl-initial-tools

Initial implementation of LLM coding tools

Author: Sewer56

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -77,8 +77,8 @@ body:
   - type: input
     id: version
     attributes:
-      label: "rig-coding-tools version"
-      description: The version of rig-coding-tools you're using
+      label: "llm-coding-tools version"
+      description: The version of llm-coding-tools you're using
       placeholder: e.g. 0.1.0
     validations:
       required: true

.github/pull_request_template.md

@@ -2,6 +2,5 @@
 
 <!--
 Please, make sure:
-- you have read the contributing guidelines:
-  https://github.com/Sewer56/rig-coding-tools/blob/main/docs/CONTRIBUTING.md
+- you have read the contributing guidelines https://reloaded-project.github.io/reloaded-templates-rust/manual/#contributing
 -->

.github/workflows/rust.yml

@@ -2,15 +2,13 @@ name: Rust
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
     tags:
-      - '*'
+      - "*"
   pull_request:
-    branches: [ main ]
+    branches: [main]
   workflow_dispatch:
 
-
-
 jobs:
   build-and-test:
     strategy:
@@ -19,20 +17,37 @@ jobs:
           - os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
             use-cross: false
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+            use-cross: false
+          - os: macos-latest
+            target: aarch64-apple-darwin
+            use-cross: false
 
     runs-on: ${{ matrix.os }}
 
     steps:
       - uses: actions/checkout@v6
 
-      - name: Run Tests and Upload Coverage
+      - name: Run Tests (async mode) and Upload Coverage
         uses: Reloaded-Project/devops-rust-test-and-coverage@v1
         with:
           rust-project-path: ./src
           upload-coverage: true
           codecov-token: ${{ secrets.CODECOV_TOKEN }}
           target: ${{ matrix.target }}
           use-cross: ${{ matrix.use-cross }}
+
+      - name: Run Tests (blocking mode) and Upload Coverage
+        uses: Reloaded-Project/devops-rust-test-and-coverage@v1
+        with:
+          rust-project-path: ./src
+          upload-coverage: true
+          codecov-token: ${{ secrets.CODECOV_TOKEN }}
+          target: ${{ matrix.target }}
+          use-cross: ${{ matrix.use-cross }}
+          cargo-test-args: "-p llm-coding-tools-core --no-default-features --features blocking"
+
       # Note: The GitHub Runner Images will contain an up to date Rust Stable Toolchain
       #       thus as per recommendation of cargo-semver-checks, we're using stable here.
       #
@@ -42,29 +57,37 @@ jobs:
         working-directory: src
         shell: bash
         run: |
-          SEARCH_RESULT=$(cargo search "^rig-coding-tools$" --limit 1)
+          # Note: binstall is available after devops-rust-test-and-coverage@v1 call
+          cargo +stable binstall --no-confirm cargo-semver-checks --force
+          rustup +stable target add ${{ matrix.target }}
 
-          if echo "$SEARCH_RESULT" | grep -q "^rig-coding-tools "; then
-              # Run semver checks on stable, because nightly sometimes gets borked in cargo-semver-checks.
-              rustup +stable target add ${{ matrix.target }}
-              # Note: binstall is available after devops-rust-test-and-coverage@v1 call
-              cargo +stable binstall --no-confirm cargo-semver-checks --force
-              cargo +stable semver-checks --target ${{ matrix.target }} 
-          else
-              echo "No previous version found on crates.io. Skipping semver checks."
-          fi
+          for CRATE in "llm-coding-tools-core" "llm-coding-tools-rig"; do
+            SEARCH_RESULT=$(cargo search "^${CRATE}$" --limit 1)
+            if echo "$SEARCH_RESULT" | grep -q "^${CRATE} "; then
+              echo "Running semver checks for ${CRATE}..."
+              cargo +stable semver-checks -p "${CRATE}" --target ${{ matrix.target }}
+            else
+              echo "No previous version of ${CRATE} found on crates.io. Skipping semver checks."
+            fi
+          done
 
       - name: Check documentation is valid
         if: github.event_name == 'pull_request' || startsWith(github.ref, 'refs/tags/')
         working-directory: src
         env:
           RUSTDOCFLAGS: "-D warnings"
-        run: cargo doc --workspace --all-features --document-private-items --target ${{ matrix.target }}
+        # Note: Can't use --all-features at workspace level because tokio/blocking are mutually exclusive
+        run: |
+          cargo doc -p llm-coding-tools-core --features tokio --document-private-items --target ${{ matrix.target }}
+          cargo doc -p llm-coding-tools-rig --document-private-items --target ${{ matrix.target }}
 
       - name: Run linter
         if: github.event_name == 'pull_request' || startsWith(github.ref, 'refs/tags/')
         working-directory: src
-        run: cargo clippy --workspace --all-features --target ${{ matrix.target }} -- -D warnings
+        # Note: Can't use --all-features at workspace level because tokio/blocking are mutually exclusive
+        run: |
+          cargo clippy -p llm-coding-tools-core --features tokio --target ${{ matrix.target }} -- -D warnings
+          cargo clippy -p llm-coding-tools-rig --target ${{ matrix.target }} -- -D warnings
 
       - name: Run formatter check
         uses: actions-rust-lang/rustfmt@v1
@@ -85,12 +108,14 @@ jobs:
         uses: Reloaded-Project/devops-publish-action@v3
         with:
           rust-crates-io-token: ${{ secrets.CRATES_IO_TOKEN }}
-          rust-cargo-project-paths: src/rig-coding-tools
+          rust-cargo-project-paths: |
+            src/llm-coding-tools-core
+            src/llm-coding-tools-rig
           compression-tool: 7z
           artifact-groups-file: .github/artifact-groups.yml
-          changelog-enabled: 'true'
+          changelog-enabled: "true"
           changelog-template: .github/changelog.hbs
           changelog-is-release: ${{ startsWith(github.ref, 'refs/tags/') }}
           changelog-release-tag: ${{ github.ref_name }}
-          changelog-override-starting-version: 'true'
-          changelog-hide-credit: 'true'
+          changelog-override-starting-version: "true"
+          changelog-hide-credit: "true"

README.MD

@@ -1,83 +1,94 @@
-# rig-coding-tools
+# llm-coding-tools
 
-## Additional Setup Required!!
+[![Crates.io - llm-coding-tools-core](https://img.shields.io/crates/v/llm-coding-tools-core.svg)](https://crates.io/crates/llm-coding-tools-core)
+[![Crates.io - llm-coding-tools-rig](https://img.shields.io/crates/v/llm-coding-tools-rig.svg)](https://crates.io/crates/llm-coding-tools-rig)
+[![Docs.rs](https://docs.rs/llm-coding-tools-rig/badge.svg)](https://docs.rs/llm-coding-tools-rig)
+[![CI](https://github.com/Sewer56/llm-coding-tools/actions/workflows/rust.yml/badge.svg)](https://github.com/Sewer56/llm-coding-tools/actions)
 
-<!-- DELETE THIS SECTION AFTER COMPLETING SETUP -->
+Lightweight, high-performance coding tool implementations for LLM-powered development agents. Plug and play into your favourite frameworks like [Rig](https://github.com/0xPlaygrounds/rig).
 
-Additional setup might be required.
-Once you do the stuff under this text, delete this section.
+## About This Workspace
 
-### Code Coverage
-To setup code coverage for this project:
+This workspace contains multiple Rust crates for integrating coding tools with LLM agents:
 
-1. Go to [Codecov][codecov], add your project.
-2. Go to [Settings -> Secrets and variables -> Actions][gh-actions-secrets] in your repo and add a repository secret named `CODECOV_TOKEN`.
-3. Do the same in [Settings -> Secrets and variables -> Dependabot][gh-actions-dependabot].
+- **[llm-coding-tools-core](./src/llm-coding-tools-core/)**: Framework-agnostic core operations and utilities
+- **[llm-coding-tools-rig](./src/llm-coding-tools-rig/)**: Rig framework-specific Tool implementations
 
-The instructions on the Codecov page will provide the token to use.
+## Features
 
+- **File Operations**: Read, write, edit files with line-numbered output
+- **Search**: Glob pattern matching and regex content search  
+- **Shell**: Cross-platform command execution with timeout
+- **Web**: URL fetching with HTML-to-markdown conversion
+- **Task Delegation**: Sub-agent spawning for complex workflows
+- **Path Security**: Choose between unrestricted or sandboxed file access
+- **Context Strings**: Embedded LLM guidance for tool usage
 
-### Setup API Key (crates.io)
+## Feature Flags (llm-coding-tools-core)
 
-You'll need to set up an API key to publish to `crates.io` on tag.
-
-- Generate your API key in [crates.io (Account Settings -> API Tokens)][crates-io-key].
-- Go to [Settings -> Secrets and variables -> Actions][gh-actions-secrets] in your repo and add environment secret named `CRATES_IO_TOKEN`.
-- Paste your API key.
-
-
-
-
-### Fill in README Documentation
-
-This repository uses a two-level README structure:
-
-| File | Purpose | What to Write |
-|------|---------|---------------|
-| `README.MD` (this file) | GitHub landing page | Project overview, quick start example, badges |
-| [`src/rig-coding-tools/README.MD`](./src/rig-coding-tools/README.MD) | crates.io page | Detailed features, installation, comprehensive usage examples |
-
------------------------
-
-[![Crates.io](https://img.shields.io/crates/v/rig-coding-tools.svg)](https://crates.io/crates/rig-coding-tools)
-[![Docs.rs](https://docs.rs/rig-coding-tools/badge.svg)](https://docs.rs/rig-coding-tools)
-[![CI](https://github.com/Sewer56/rig-coding-tools/actions/workflows/rust.yml/badge.svg)](https://github.com/Sewer56/rig-coding-tools/actions)
-
-Basic coding tools for rig based LLM agents
+- `tokio` (default): Async mode with tokio runtime
+- `blocking`: Sync/blocking mode, mutually exclusive with `async`
 
 ## Quick Start
 
 Add to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-rig-coding-tools = "0.1.0"
+llm-coding-tools-rig = "0.1"
 ```
 
 ```rust
-// TODO: Add a minimal example showing the most common use case
+use llm_coding_tools_rig::absolute::{ReadTool, WriteTool, GlobTool};
+use llm_coding_tools_rig::{BashTool, PreambleBuilder, TodoTools};
+use rig::tool::ToolSet;
+
+// Track tools and generate LLM guidance
+let mut pb = PreambleBuilder::new();
+let todos = TodoTools::new();
+
+let toolset = ToolSet::builder()
+    .static_tool(pb.track(ReadTool::<true>::new()))
+    .static_tool(pb.track(WriteTool::new()))
+    .static_tool(pb.track(GlobTool::new()))
+    .static_tool(pb.track(BashTool::new()))
+    .static_tool(pb.track(todos.read))
+    .static_tool(pb.track(todos.write))
+    .build();
+
+// Generate preamble for agent system prompt
+let preamble = pb.build();
+
+// Use with rig agent:
+// let agent = client.agent("gpt-4o")
+//     .preamble(&preamble)
+//     .tools(toolset)
+//     .build();
 ```
-See the [rig-coding-tools crate documentation](./src/rig-coding-tools/README.MD) for detailed usage.
 
-## Crates
+## Examples
 
-- [rig-coding-tools](./src/rig-coding-tools/README.MD): Core library <!-- TODO: Update description -->
+```bash
+# Basic toolset setup
+cargo run --example basic -p llm-coding-tools-rig
 
-## Developer Manual
+# Complete agent configuration (recommended starting point)
+cargo run --example full_agent -p llm-coding-tools-rig
 
-For step-by-step development guidance, see the [Developer Manual](https://reloaded-project.github.io/reloaded-templates-rust/manual/).
+# Sandboxed file access
+cargo run --example sandboxed -p llm-coding-tools-rig
+```
+
+## Documentation
+
+- [llm-coding-tools-core README](./src/llm-coding-tools-core/README.md)
+- [llm-coding-tools-rig README](./src/llm-coding-tools-rig/README.md)
+- [Developer Guidelines](./src/AGENTS.md)
 
 ## Contributing
 
-We welcome contributions! See the [Contributing Guide](https://reloaded-project.github.io/reloaded-templates-rust/manual/#contributing) for details.
+Contributions are welcome! Please ensure all tests pass and the code follows our guidelines.
 
 ## License
 
 Licensed under [Apache 2.0](./LICENSE).
-
-[codecov]: https://app.codecov.io
-[gh-actions-secrets]: https://github.com/Sewer56/rig-coding-tools/settings/secrets/actions
-[gh-actions-dependabot]: https://github.com/Sewer56/rig-coding-tools/settings/secrets/dependabot
-[gh-pages]: https://github.com/Sewer56/rig-coding-tools/settings/pages
-[crates-io-key]: https://crates.io/settings/tokens
-[nuget-key]: https://www.nuget.org/account/apikeys

README.md

@@ -4,7 +4,7 @@
     {
       "label": "Auto Test on Save",
       "type": "shell",
-      "command": "cargo install cargo-watch --quiet && cargo watch -x \"test\" -w rig-coding-tools/src",
+      "command": "cargo install cargo-watch --quiet && cargo watch -x \"test\" -w llm-coding-tools-core/src -w llm-coding-tools-rig/src",
       "group": "test",
       "presentation": {
         "reveal": "always"
@@ -14,7 +14,7 @@
     {
       "label": "Auto Coverage on Save",
       "type": "shell",
-      "command": "cargo install cargo-watch --quiet && cargo install cargo-tarpaulin --quiet && cargo watch -x \"tarpaulin --skip-clean --out Xml --out Html --engine llvm --target-dir target/coverage-build\" -w rig-coding-tools/src",
+      "command": "cargo install cargo-watch --quiet && cargo install cargo-tarpaulin --quiet && cargo watch -x \"tarpaulin --skip-clean --out Xml --out Html --engine llvm --target-dir target/coverage-build\" -w llm-coding-tools-core/src -w llm-coding-tools-rig/src",
       "group": "test",
       "presentation": {
         "reveal": "always"