diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 937023d..bda7e10 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,6 +1,6 @@ -# This file was autogenerated by dist: https://github.com/astral-sh/cargo-dist +# This file was autogenerated by dist: https://axodotdev.github.io/cargo-dist # -# Copyright 2025 Astral Software Inc. +# Copyright 2022-2024, axodotdev # SPDX-License-Identifier: MIT or Apache-2.0 # # CI that: @@ -58,12 +58,13 @@ jobs: steps: - uses: actions/checkout@v4 with: + persist-credentials: false submodules: recursive - name: Install dist # we specify bash to get pipefail; it guards against the `curl` command # failing. otherwise `sh` won't catch that `curl` returned non-0 shell: bash - run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/astral-sh/cargo-dist/releases/download/v0.28.3/cargo-dist-installer.sh | sh" + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.30.0/cargo-dist-installer.sh | sh" - name: Cache dist uses: actions/upload-artifact@v4 with: @@ -117,6 +118,7 @@ jobs: git config --global core.longpaths true - uses: actions/checkout@v4 with: + persist-credentials: false submodules: recursive - name: Install Rust non-interactively if not already installed if: ${{ matrix.container }} @@ -175,6 +177,7 @@ jobs: steps: - uses: actions/checkout@v4 with: + persist-credentials: false submodules: recursive - name: Install cached dist uses: actions/download-artifact@v4 @@ -224,6 +227,7 @@ jobs: steps: - uses: actions/checkout@v4 with: + persist-credentials: false submodules: recursive - name: Install cached dist uses: actions/download-artifact@v4 @@ -286,6 +290,7 @@ jobs: steps: - uses: actions/checkout@v4 with: + persist-credentials: true repository: "rust-mcp-stack/homebrew-tap" token: ${{ secrets.HOMEBREW_TAP_TOKEN }} # So we have access to the formula @@ -332,4 +337,5 @@ jobs: steps: - uses: actions/checkout@v4 with: + persist-credentials: false submodules: recursive diff --git a/README.md b/README.md index c7975f9..b1cfef9 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,16 @@ powershell -ExecutionPolicy Bypass -c "irm https://github.com/rust-mcp-stack/rus ```sh brew install rust-mcp-stack/tap/rust-mcp-filesystem ``` + + +- **NPM** + +```sh +npm i -g @rustmcp/rust-mcp-filesystem@latest +``` +> The npm package is provided for convenience. It runs the same underlying Rust binary but can be installed and used as a standard npm package. + + - **Docker** https://hub.docker.com/mcp/server/rust-mcp-filesystem diff --git a/dist-workspace.toml b/dist-workspace.toml index 95fe410..f833e44 100644 --- a/dist-workspace.toml +++ b/dist-workspace.toml @@ -6,11 +6,11 @@ members = ["cargo:."] # Path that installers should place binaries in install-path = "~/.rust-mcp-stack/bin" # The preferred dist version to use in CI (Cargo.toml SemVer syntax) -cargo-dist-version = "0.28.3" +cargo-dist-version = "0.30.0" # CI backends to support ci = "github" # The installers to generate for each app -installers = ["shell", "powershell", "homebrew", "msi"] +installers = ["shell", "powershell", "npm", "homebrew", "msi"] # Target platforms to build apps for (Rust target-triple syntax) targets = ["aarch64-apple-darwin", "aarch64-unknown-linux-gnu", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"] # The archive format to use for non-windows builds (defaults .tar.xz) @@ -23,6 +23,8 @@ create-release = false tap = "rust-mcp-stack/homebrew-tap" # Publish jobs to run in CI publish-jobs = ["homebrew"] +# A namespace to use when publishing this package to the npm registry +npm-scope = "@rustmcp" [dist.github-custom-runners] global = "ubuntu-22.04" diff --git a/docs/README.md b/docs/README.md index f5c7d4b..65fcd62 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,6 +19,43 @@ This project is a pure Rust rewrite of the JavaScript-based **@modelcontextproto Refer to the [quickstart](quickstart.md) guide for installation and configuration instructions. +##### **Shell script** + + + +```sh +curl --proto '=https' --tlsv1.2 -LsSf https://github.com/rust-mcp-stack/rust-mcp-filesystem/releases/download/v0.3.6/rust-mcp-filesystem-installer.sh | sh +``` + +##### **PowerShell script** + +```sh +powershell -ExecutionPolicy Bypass -c "irm https://github.com/rust-mcp-stack/rust-mcp-filesystem/releases/download/v0.3.6/rust-mcp-filesystem-installer.ps1 | iex" +``` + +##### **Homebrew** + +```sh +brew install rust-mcp-stack/tap/rust-mcp-filesystem +``` + +##### **NPM** + +```sh +npm i -g @rustmcp/rust-mcp-filesystem@latest +``` +> The npm package is provided for convenience. It runs the same underlying Rust binary but can be installed and used as a standard npm package. + +##### **Docker** + + https://hub.docker.com/mcp/server/rust-mcp-filesystem + +##### **Download Binaries** + +https://github.com/rust-mcp-stack/rust-mcp-filesystem/releases/tag/v0.3.6 + + + ## Purpose This project aims to provide a reliable, secure, and feature-rich MCP server for filesystem management, reimagining the capabilities of **@modelcontextprotocol/server-filesystem** in a more performant and type-safe language. Whether you’re using this for file exploration, automation, or system integration, rust-mcp-filesystem offers a solid foundation.