Merge pull request #32 from cordfuse/feat/sync-rebase #25
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Release | |
| on: | |
| push: | |
| tags: | |
| - 'v*' | |
| permissions: | |
| contents: write | |
| jobs: | |
| release: | |
| name: Create release | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Get version | |
| id: version | |
| run: echo "VERSION=$(cat version.txt | tr -d '[:space:]')" >> $GITHUB_OUTPUT | |
| - name: Create release | |
| uses: softprops/action-gh-release@v2 | |
| with: | |
| name: Cortex v${{ steps.version.outputs.VERSION }} | |
| body: | | |
| # Cortex v${{ steps.version.outputs.VERSION }} | |
| --- | |
| ## Install on your computer (Mac · Linux · Windows) | |
| ### Mac or Linux | |
| Open Terminal. Paste this. Hit Enter. | |
| ```bash | |
| curl -fsSL https://github.com/cordfuse/cortex/releases/latest/download/install.sh | bash | |
| ``` | |
| It will ask you two things: | |
| 1. Your repo URL (the GitHub repo you created from the Cortex template) | |
| 2. Where to put it on your computer (just hit Enter to use the default) | |
| That's it. | |
| --- | |
| ### Windows | |
| Open PowerShell. Paste this. Hit Enter. | |
| ```powershell | |
| iex (irm https://github.com/cordfuse/cortex/releases/latest/download/install.ps1) | |
| ``` | |
| Same two questions. Same deal. | |
| --- | |
| ## On your phone or in a browser? (Claude / ChatGPT) | |
| No install needed — Cortex runs from a Claude project or a ChatGPT project. Create the project, add a GitHub token, say **hello**. | |
| **→ Mobile & web setup guide:** https://github.com/cordfuse/cortex/blob/main/manifest/framework/SETUP-MOBILE.md | |
| Works on Claude (claude.ai) and ChatGPT, web and mobile. Journaling and recall work fully; live connectors (Google, Microsoft 365, etc.) are desktop/CLI only. (Gemini web and mobile aren't supported.) | |
| --- | |
| ## Don't have a repo yet? | |
| 1. Go to https://github.com/cordfuse/cortex | |
| 2. Click the green **"Use this template"** button → **"Create a new repository"** | |
| 3. Give it a name (e.g. `cortex`), set it to **Private**, click **Create repository** | |
| 4. Copy your new repo's URL | |
| 5. Run the installer above and paste the URL when it asks | |
| --- | |
| ## Already set up on another machine? | |
| Run the same installer. When it asks for your repo URL, give it the same one. | |
| It will clone your existing records and repair your environment. | |
| Nothing gets overwritten. | |
| --- | |
| ## What the installer does | |
| - Checks what's installed on your machine (git, Bun, etc.) | |
| - Installs anything that's missing | |
| - Asks for your repo URL and where to clone it | |
| - Warns you if your repo is public (it should be private) | |
| - Clones your repo | |
| - Installs all Cortex dependencies | |
| When it's done: open the folder in your AI agent (Claude, ChatGPT, etc.) and say **hello**. | |
| files: | | |
| install/install.sh | |
| install/install.ps1 | |
| draft: false | |
| prerelease: false |