Skip to content

feat: add curl-based installer and documentation #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Intina47 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add curl-based installer and documentation #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,20 @@ Local-first memory layer for AI development tools via MCP.
![alt text](image.png)

## Install and auto-config (60 seconds)
1) Install globally:
Choose one install method:

**Option A: npm (recommended)**
```bash
npm install -g @context-sync/server
```

**Option B: curl**
```bash
curl -fsSL https://raw.githubusercontent.com/Intina47/context-sync/main/bin/install.sh | bash
```

Requires Node.js 18+ and npm.

2) Auto-config runs on install. Restart your AI tool.

3) Verify tools:
Expand Down
25 changes: 25 additions & 0 deletions bin/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#!/usr/bin/env bash
set -euo pipefail

PACKAGE_NAME="@context-sync/server"
VERSION_SUFFIX=""

if [[ -n "${CONTEXT_SYNC_VERSION:-}" ]]; then
VERSION_SUFFIX="@${CONTEXT_SYNC_VERSION}"
fi

if ! command -v node >/dev/null 2>&1; then
echo "❌ Node.js is required (>= 18). Install Node.js and retry." >&2
exit 1
fi

if ! command -v npm >/dev/null 2>&1; then
echo "❌ npm is required. Install npm and retry." >&2
exit 1
fi

echo "🧠 Installing Context Sync MCP Server..."

npm install -g "${PACKAGE_NAME}${VERSION_SUFFIX}"

echo "✅ Install complete. Restart your AI tool to load Context Sync."
2 changes: 2 additions & 0 deletions docs/RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This release is a major v2-focused cleanup. It removes legacy v1 tooling and nar
- Notion-only setup wizard with clearer prompts and retry flow.
- Post-install status tracking with manual-config fallback when auto-config fails.
- Setup wizard now summarizes auto-configured platforms and any install issues.
- Added a curl-based installer for global installs.

## Breaking changes
- Removed v1-only tools (todos, platform sync, call graph, type analysis, dependency analysis, file write/preview tools, performance monitor, migration prompter, and related modules).
Expand All @@ -25,3 +26,4 @@ This release is a major v2-focused cleanup. It removes legacy v1 tooling and nar
- Auto-config does not run on local installs; use global install or manual config.
- Notion setup is intentionally manual via the wizard.
- Fixed Windows setup command failing due to a stray BOM in the setup script.
- The curl installer wraps the same npm global install flow.