feat: align cli release artifacts with codecane

Author: brandonkachen

.github/workflows/cli-release-build.yml

@@ -210,13 +210,13 @@ jobs:
           if [[ "${{ runner.os }}" == "Windows" ]]; then
             BINARY_FILE="${{ inputs.binary-name }}.exe"
           fi
-          tar -czf codebuff-cli-${{ matrix.target }}.tar.gz -C cli/bin "$BINARY_FILE"
+          tar -czf codecane-${{ matrix.target }}.tar.gz -C cli/bin "$BINARY_FILE"
 
       - name: Upload binary artifact
         uses: actions/upload-artifact@v4
         with:
-          name: codebuff-cli-${{ matrix.target }}
-          path: codebuff-cli-${{ matrix.target }}.tar.gz
+          name: codecane-${{ matrix.target }}
+          path: codecane-${{ matrix.target }}.tar.gz
 
       - name: Open debug shell on failure
         if: failure()

.github/workflows/cli-release-staging.yml

@@ -14,7 +14,7 @@ permissions:
 jobs:
   prepare-and-commit-staging:
     runs-on: ubuntu-latest
-    if: contains(github.event.pull_request.title, '[codebuff-cli]')
+    if: contains(github.event.pull_request.title, '[codecane]')
     outputs:
       new_version: ${{ steps.bump_version.outputs.new_version }}
     steps:
@@ -110,7 +110,7 @@ jobs:
       - name: Commit staging release snapshot
         run: |
           git add -A
-          git commit -m "Staging CLI Release v${{ steps.bump_version.outputs.new_version }} [codebuff-cli]
+          git commit -m "Staging CLI Release v${{ steps.bump_version.outputs.new_version }} [codecane]
 
           Captures the staged state for the CLI prerelease, including the version bump.
 
@@ -132,7 +132,7 @@ jobs:
     needs: prepare-and-commit-staging
     uses: ./.github/workflows/cli-release-build.yml
     with:
-      binary-name: codebuff-cli
+      binary-name: codecane
       new-version: ${{ needs.prepare-and-commit-staging.outputs.new_version }}
       artifact-name: cli-staging-metadata
       checkout-ref: ${{ github.event.pull_request.head.sha }}
@@ -191,18 +191,18 @@ jobs:
         run: |
           CURRENT_TIME=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
           RELEASE_BODY=$(cat <<'EOF'
-          ## Codebuff CLI v${VERSION} (Staging)
+          ## Codecane v${VERSION} (Staging)
 
           **⚠️ This is a staging build intended for internal testing.**
 
           ### Included Binaries
-          - `codebuff-cli-linux-x64.tar.gz`
-          - `codebuff-cli-linux-arm64.tar.gz`
-          - `codebuff-cli-darwin-x64.tar.gz`
-          - `codebuff-cli-darwin-arm64.tar.gz`
-          - `codebuff-cli-win32-x64.tar.gz`
+          - `codecane-linux-x64.tar.gz`
+          - `codecane-linux-arm64.tar.gz`
+          - `codecane-darwin-x64.tar.gz`
+          - `codecane-darwin-arm64.tar.gz`
+          - `codecane-win32-x64.tar.gz`
 
-          After downloading, extract the tarball, add the binary to your PATH, and run `codebuff-cli --help` for usage.
+          After downloading, extract the tarball, add the binary to your PATH, and run `codecane --help` for usage.
           EOF
           )
 
@@ -213,7 +213,7 @@ jobs:
             https://api.github.com/repos/CodebuffAI/codebuff/releases \
             -d "{
               \"tag_name\": \"v${VERSION}\",
-              \"name\": \"Codebuff CLI v${VERSION} (Staging)\",
+              \"name\": \"Codecane v${VERSION} (Staging)\",
               \"body\": \"${RELEASE_BODY//$'\n'/\\n}\",
               \"prerelease\": true,
               \"published_at\": \"$CURRENT_TIME\"
@@ -231,7 +231,7 @@ jobs:
             exit 1
           fi
 
-          for file in binaries/*/codebuff-cli-*; do
+          for file in binaries/*/codecane-*; do
             if [ -f "$file" ]; then
               FILENAME=$(basename "$file")
               echo "Uploading $FILENAME"
@@ -242,3 +242,33 @@ jobs:
                 "https://uploads.github.com/repos/CodebuffAI/codebuff/releases/$RELEASE_ID/assets?name=$FILENAME"
             fi
           done
+
+  publish-staging-npm:
+    needs: [prepare-and-commit-staging, build-staging-binaries, create-staging-release]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Download CLI staging package
+        uses: actions/download-artifact@v4
+        with:
+          name: cli-staging-metadata
+          path: cli/release-staging/
+
+      - name: Set up Node.js for npm publishing
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - name: Publish codecane staging package to npm
+        run: |
+          cd cli/release-staging
+          npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

cli/package.json

@@ -19,7 +19,7 @@
     "prebuild": "bun run build:sdk",
     "build": "bun build src/index.tsx --outdir dist --target node --format esm",
     "build:sdk": "cd ../sdk && bun run build",
-    "build:binary": "bun ./scripts/build-binary.ts codebuff-cli $npm_package_version",
+    "build:binary": "bun ./scripts/build-binary.ts codecane $npm_package_version",
     "start": "bun run dist/index.js",
     "pretypecheck": "bun run build:sdk",
     "typecheck": "tsc --noEmit -p ."

cli/release-staging/README.md

@@ -1,3 +1,71 @@
-# Codebuff CLI Staging
+# 🚀 Codecane - The most powerful coding agent (STAGING)
 
-The staging workflow updates these files with the exact version being packaged. They are shipped as workflow artifacts so downstream jobs build and publish binaries from the same commit snapshot.
+**⚠️ This is a staging/beta release for testing purposes.**
+
+Codecane is a CLI tool that writes code for you.
+
+1. Run `codecane` from your project directory
+2. Tell it what to do
+3. It will read and write to files and run commands to produce the code you want
+
+Note: Codecane will run commands in your terminal as it deems necessary to fulfill your request.
+
+## Installation
+
+To install Codecane (staging), run:
+
+```bash
+npm install -g codecane@beta
+```
+
+(Use `sudo` if you get a permission error.)
+
+## Usage
+
+After installation, you can start Codecane by running:
+
+```bash
+codecane [project-directory]
+```
+
+If no project directory is specified, Codecane will use the current directory.
+
+Once running, simply chat with Codecane to say what coding task you want done.
+
+## Features
+
+- Understands your whole codebase
+- Creates and edits multiple files based on your request
+- Can run your tests or type checker or linter; can install packages
+- It's powerful: ask Codecane to keep working until it reaches a condition and it will.
+
+Our users regularly use Codecane to implement new features, write unit tests, refactor code, write scripts, or give advice.
+
+## Knowledge Files
+
+To unlock the full benefits of modern LLMs, we recommend storing knowledge alongside your code. Add a `knowledge.md` file anywhere in your project to provide helpful context, guidance, and tips for the LLM as it performs tasks for you.
+
+Codecane can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
+
+Some have said every change should be paired with a unit test. In 2024, every change should come with a knowledge update!
+
+## Tips
+
+1. Type '/help' or just '/' to see available commands.
+2. Create a `knowledge.md` file and collect specific points of advice. The assistant will use this knowledge to improve its responses.
+3. Type `undo` or `redo` to revert or reapply file changes from the conversation.
+4. Press `Esc` or `Ctrl+C` while Codecane is generating a response to stop it.
+
+## Troubleshooting
+
+If you are getting permission errors during installation, try using sudo:
+
+```
+sudo npm install -g codecane@beta
+```
+
+If you still have errors, it's a good idea to [reinstall Node](https://nodejs.org/en/download).
+
+## Feedback
+
+We value your input! Please email your feedback to `[email protected]`. Thank you for using Codecane!