Install BackMark
Get BackMark installed and running in minutes.
Quick Install
Installs BackMark globally on your system
Prerequisites
System Requirements
- Node.js: Version 18.0.0 or higher
- npm: Version 8.0.0 or higher
- Operating System: Linux, macOS, or Windows
- Disk Space: ~50MB for installation
Check Your System
Don't have Node.js?
Download and install from nodejs.org (LTS version recommended)
Installation Methods
Method 1: Global Installation (Recommended)
Install BackMark globally to use it from any directory:
Benefits:
- ✅ Available system-wide
- ✅ Simple
backmarkcommand - ✅ One-time installation
Method 2: Using npx (No Installation)
Run BackMark without installing:
Benefits:
- ✅ No global installation
- ✅ Always uses latest version
- ✅ Good for trying BackMark
Note: Slightly slower as it downloads on each use.
Method 3: Development Installation
For contributors or those wanting to modify BackMark:
Benefits:
- ✅ Latest development features
- ✅ Ability to contribute
- ✅ Local modifications
Verify Installation
After installation, verify BackMark is working correctly:
✅ If you see the version number and help output, BackMark is installed correctly!
Troubleshooting
Command not found: backmark
If you get "command not found" after global installation:
Solution 1: Check npm global bin path
Add the bin directory to your PATH:
# For bash (~/.bashrc or ~/.bash_profile)
export PATH="$PATH:/usr/local/bin"
# For zsh (~/.zshrc)
export PATH="$PATH:/usr/local/bin"Solution 2: Use npx instead
npx @grazulex/backmark [command]Permission denied (EACCES)
If you get permission errors during installation:
Solution: Use a Node version manager
Recommended: Use nvm (Node Version Manager)
# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
# Install Node.js
nvm install --lts
# Install BackMark
npm install -g @grazulex/backmarkAlternative: Use sudo npm install -g (not recommended)
Old version of BackMark
To update to the latest version:
Need More Help?
If you're still experiencing issues:
- 📖 Check the Getting Started guide
- 🐛 Report bugs on GitHub Issues
- 💬 Ask questions in GitHub Discussions
Next Steps
1. Initialize Project
backmark init "My Project"Create your first BackMark project
2. Create a Task
backmark task create "First task"Add your first task
3. View Board
backmark board showSee your Kanban board