craft

(β˜… 193)

The universal Sentry release CLI πŸš€

  • .craft.yml
  • .dockerignore
  • .gitignore
  • .lore.md
  • .nojekyll
  • .npmignore
  • .prettierignore
  • .prettierrc.yml
  • action.yml
  • AGENTS.md
  • blog-post-draft.md
  • build.mjs
  • CHANGELOG.md
  • CONTRIBUTING.md
  • Dockerfile
  • eslint.config.mjs
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • README.md
  • tsconfig.build.json
  • tsconfig.json
  • vitest.config.mts

# Installation Guide

1. Get the code
git clone https://github.com/getsentry/craft

Downloads the entire project code from GitHub to your computer.

cd craft

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g @sentry/craft

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t craft .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 craft

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g @sentry/craft

Installs the package published on the npm registry globally β€” no need to clone the source.

- name: npm

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation