Olivier/cursor-nixos-flake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Migrate to clean package-only structure

Browse Source 
- Simplified flake.nix to focus only on packaging Cursor
- Removed system configuration files (archived locally)
- Updated to clean, reusable flake structure
- Added simple update-cursor.sh script
- Updated documentation for new structure

This migration  makes the flake purely focused on providing the Cursor package.
This commit is contained in:
thinktankmachine
2025-08-28 16:02:32 +10:00
parent 166e835dc5
commit f77f5b1131
12 changed files with 458 additions and 1064 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+114 -265
View File
@@ -1,55 +1,50 @@
# Cursor NixOS Flake
A NixOS flake that provides Cursor (AI-first code editor) as an AppImage with enhanced compatibility for NixOS systems.
A clean, simple NixOS flake for packaging the [Cursor](https://cursor.sh/) AI-powered code editor.
## Features
## 📦 What This Flake Provides
- **Cursor 1.5.1**: Latest version of the AI-first code editor
- **Enhanced AppImage Support**: Optimized for NixOS with proper library paths and environment setup
- **Easy Integration**: Can be used as a standalone system or integrated into existing NixOS flakes
- **Development Tools**: Complete development environment with modern tools
- **Modern Shell**: Zsh with Starship prompt and useful aliases
This flake packages Cursor as a Nix package that can be easily integrated into any NixOS system or used standalone.
## Quick Start
**Packages:**
- `packages.x86_64-linux.cursor` - The Cursor editor
- `packages.x86_64-linux.default` - Same as cursor (default package)
### Option 1: Use as a Standalone System
## 🚀 Quick Start
```bash
# Clone the repository
git clone https://github.com/thinktankmachine/cursor-nixos-flake
cd cursor-nixos-flake
### Using in Your NixOS Configuration
# Build and switch to the configuration
sudo nixos-rebuild switch --flake .#cursor-system
```
### Option 2: Integrate into Existing NixOS Flake
Add to your `/etc/nixos/flake.nix`:
Add this flake as an input to your main system flake:
```nix
{
inputs = {
# ... your existing inputs
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
cursor-flake = {
url = "github:thinktankmachine/cursor-nixos-flake";
url = "path:/path/to/cursor-flake"; # Update this path
inputs.nixpkgs.follows = "nixpkgs";
inputs.home-manager.follows = "home-manager";
};
# ... other inputs
};
outputs = { nixpkgs, home-manager, cursor-flake, ... }: {
nixosConfigurations.your-system = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
outputs = { nixpkgs, cursor-flake, ... }: {
nixosConfigurations.your-hostname = nixpkgs.lib.nixosSystem {
# ...
modules = [
# ... your existing modules
./configuration.nix
{
# Add Cursor to your system packages
environment.systemPackages = with pkgs; [
cursor-flake.packages.x86_64-linux.cursor
# ... other packages
];
}
# Or in home-manager:
{
home-manager.users.your-username = { pkgs, ... }: {
home.packages = with pkgs; [
# ... your existing packages
] ++ [
# Add Cursor from the flake
home.packages = [
cursor-flake.packages.x86_64-linux.cursor
# ... other packages
];
};
}
@@ -59,274 +54,128 @@ Add to your `/etc/nixos/flake.nix`:
}
```
Then rebuild:
```bash
sudo nix flake update
sudo nixos-rebuild switch --flake .#your-system
```
### Standalone Usage
## Usage
After installation, Cursor will be available:
- **Applications Menu**: Look for "Cursor" in your desktop environment
- **Terminal**: Run `cursor` from any terminal
- **Command Line**: Use `cursor --version` to verify installation
## Updating Cursor
When a new version of Cursor is released, follow these steps to update the flake:
### Step 1: Find the New Download URL
1. Go to [Cursor's download page](https://cursor.sh/)
2. Find the Linux AppImage download link
3. Copy the URL (it will look like: `https://downloads.cursor.com/production/[hash]/linux/x64/Cursor-[version]-x86_64.AppImage`)
### Step 2: Update the Flake
1. **Update the URL in `home.nix`**:
```nix
# Find this section in home.nix
cursorAppImage = pkgs.writeShellScriptBin "cursor" ''
# ... environment setup ...
# Run the AppImage with appimage-run
exec ${pkgs.appimage-run}/bin/appimage-run ${pkgs.fetchurl {
url = "https://downloads.cursor.com/production/[NEW_HASH]/linux/x64/Cursor-[NEW_VERSION]-x86_64.AppImage";
sha256 = "OLD_HASH_HERE"; # This will be updated in the next step
}} "$@"
'';
```
2. **Update the SHA256 hash**:
```bash
# Run the update script (it will fetch the new URL and update the hash)
./update-cursor-hash.sh
```
3. **Test the build**:
```bash
# Test that the flake builds correctly
nix build .#packages.x86_64-linux.cursor
```
4. **Update your system**:
```bash
# If using standalone system
sudo nixos-rebuild switch --flake .#cursor-system
# If integrated into main system
cd /etc/nixos
sudo nix flake update
sudo nixos-rebuild switch --flake .#your-system
```
### Step 3: Verify the Update
You can also build and run Cursor directly from this flake:
```bash
# Check the version
cursor --version
# Build the package
nix build .#cursor
# Launch Cursor to ensure it works
cursor
# Run Cursor
./result/bin/cursor
# Or run directly without building
nix run .#cursor
```
### Step 4: Commit and Push (Optional)
## 🔄 Updating Cursor
When a new version of Cursor is released, use the included update script:
### Method 1: Automatic with URL
```bash
# Commit the changes
git add .
git commit -m "Update Cursor to version [NEW_VERSION]"
git push origin main
./update-cursor.sh "https://downloads.cursor.com/production/[hash]/linux/x64/Cursor-1.6.0-x86_64.AppImage"
```
## Configuration
### Customizing the Cursor Wrapper
The Cursor AppImage wrapper in `home.nix` includes enhanced compatibility settings:
```nix
cursorAppImage = pkgs.writeShellScriptBin "cursor" ''
# Set up environment for better AppImage compatibility
export APPDIR=""
export ARGV0=""
export OWD=""
# Ensure proper library paths
export LD_LIBRARY_PATH="${pkgs.lib.makeLibraryPath [
pkgs.glib
pkgs.gtk3
pkgs.cairo
pkgs.pango
pkgs.atk
pkgs.gdk-pixbuf
pkgs.xorg.libX11
pkgs.xorg.libXcomposite
pkgs.xorg.libXcursor
pkgs.xorg.libXext
pkgs.xorg.libXfixes
pkgs.xorg.libXi
pkgs.xorg.libXrandr
pkgs.xorg.libXrender
pkgs.xorg.libXtst
pkgs.nss
pkgs.nspr
pkgs.dbus
pkgs.at-spi2-atk
pkgs.at-spi2-core
pkgs.mesa
pkgs.alsa-lib
]}:$LD_LIBRARY_PATH"
# Run the AppImage with appimage-run
exec ${pkgs.appimage-run}/bin/appimage-run ${pkgs.fetchurl {
url = "https://downloads.cursor.com/production/[hash]/linux/x64/Cursor-[version]-x86_64.AppImage";
sha256 = "[hash]";
}} "$@"
'';
```
### Adding Additional Packages
To add more development tools, edit `home.nix`:
```nix
home.packages = with pkgs; [
# Existing packages...
# Add your packages here
nodejs_20
python3
rustc
cargo
# ... more packages
];
```
## Troubleshooting
### Common Issues
#### 1. AppImage Won't Run
**Symptoms**: `bwrap: Can't chdir to /etc/nixos: No such file or directory`
**Solution**: Run Cursor from your home directory, not from system directories:
### Method 2: Interactive
```bash
cd ~
cursor
./update-cursor.sh
# Follow the prompts to enter version or URL
```
#### 2. Keymapping Errors
**Symptoms**: `Error: Cannot find module './build/Debug/keymapping'`
**Solution**: These are cosmetic errors and don't prevent Cursor from working. The enhanced wrapper includes additional environment variables to reduce these errors.
#### 3. Update Mechanism Crashes
**Symptoms**: Cursor crashes when trying to update, shows "update available" but fails to install
**Solution**: The enhanced wrapper disables Cursor's auto-update mechanism to prevent crashes. To update Cursor, use the flake's update process instead:
### Method 3: Version number
```bash
# Update to a new version
./update-cursor-hash.sh
sudo nixos-rebuild switch --flake .#your-system
./update-cursor.sh "1.6.0"
# Script will prompt for the full download URL
```
#### 4. Library Loading Issues
The script will automatically:
- ✅ Update the version in `flake.nix`
- ✅ Update the download URL
- ✅ Fetch and update the SHA256 hash
- ✅ Test that the package builds correctly
- ✅ Verify the version is correct
**Symptoms**: Various library-related errors
**Solution**: The enhanced wrapper includes all necessary libraries. If issues persist, try:
```bash
# Rebuild the system
sudo nixos-rebuild switch --flake .#your-system
# Clear AppImage cache
rm -rf ~/.cache/appimage-run/*
```
#### 5. Git Authentication Issues
**Symptoms**: `fatal: Authentication failed`
**Solution**: Ensure your remote uses SSH:
```bash
git remote set-url origin git@github.com:username/repo.git
```
### Testing the Flake
You can test the flake without affecting your system:
```bash
# Build the VM image
nix build .#nixosConfigurations.cursor-system.config.system.build.vm
# Run the VM
./result/bin/run-cursor-system-vm
```
## File Structure
## 📁 Repository Structure
```
cursor-flake/
├── flake.nix # Main flake definition with outputs
├── configuration.nix # NixOS system configuration
├── home.nix # Home Manager configuration with Cursor wrapper
├── hardware-configuration.nix # Hardware-specific settings
├── update-cursor-hash.sh # Script to update Cursor hash
├── test-configuration.nix # Minimal test configuration
├── test-home.nix # Minimal test home configuration
└── README.md # This documentation
├── flake.nix # Main flake configuration (package-only)
├── flake.lock # Flake lock file
├── update-cursor.sh # Update script for new versions
├── README.md # This file
├── LICENSE # MIT License
└── archive-old-system-configs/ # Archived old system configs
├── configuration.nix # (archived - was for full system setup)
├── home.nix # (archived - was for home-manager)
└── ... # (other archived files)
```
## Development
### Adding Features
1. **New packages**: Add to `home.packages` in `home.nix`
2. **System changes**: Modify `configuration.nix`
3. **User settings**: Update `home.nix` configuration
## 🔧 Development
### Testing Changes
```bash
# Test the flake syntax
nix flake check
# Test that the package builds
nix build .#cursor
# Test building the package
nix build .#packages.x86_64-linux.cursor
# Test that it runs
./result/bin/cursor --version
# Test the full system
nix build .#nixosConfigurations.cursor-system.config.system.build.vm
# Clean build (removes cached results)
nix build .#cursor --rebuild
```
## Contributing
### Manual Updates
1. Fork the repository
2. Create a feature branch: `git checkout -b feature-name`
3. Make your changes
4. Test thoroughly: `nix flake check`
5. Commit: `git commit -m "Add feature description"`
6. Push: `git push origin feature-name`
7. Submit a pull request
If you prefer to update manually:
## License
1. Get the new AppImage URL from [cursor.sh](https://cursor.sh)
2. Update version and URL in `flake.nix`
3. Get the new hash:
```bash
nix-prefetch-url "https://downloads.cursor.com/production/[hash]/linux/x64/Cursor-X.Y.Z-x86_64.AppImage"
```
4. Update the hash in `flake.nix`
5. Test: `nix build .#cursor`
This project is licensed under the MIT License.
## 🏗️ Architecture
## Support
This flake uses `appimageTools.wrapType2` to properly package the Cursor AppImage with all necessary dependencies. The wrapper:
- **Issues**: [GitHub Issues](https://github.com/thinktankmachine/cursor-nixos-flake/issues)
- **Discussions**: [GitHub Discussions](https://github.com/thinktankmachine/cursor-nixos-flake/discussions)
- Bundles required system libraries
- Sets up proper environment variables
- Disables Cursor's built-in updater (managed by Nix instead)
- Creates temporary directories to avoid permission issues
- Provides a clean `cursor` command
## Acknowledgments
## 🆚 Migration from Complex Structure
- [Cursor](https://cursor.sh/) team for the excellent AI-first editor
- [NixOS](https://nixos.org/) community for the amazing package management system
- [Home Manager](https://github.com/nix-community/home-manager) for user configuration management
This flake was simplified from a previous version that included full NixOS system configurations. The old structure has been archived in `archive-old-system-configs/` for reference.
**Benefits of the new structure:**
- ✅ **Focused**: Just packages Cursor, nothing else
- ✅ **Reusable**: Easy to integrate into any NixOS system
- ✅ **Maintainable**: No complex system configurations to maintain
- ✅ **Safe**: No risk of breaking your system during updates
- ✅ **Consistent**: Matches the pattern of other package flakes
## 📜 License
MIT License - see [LICENSE](LICENSE) file.
## 🤝 Contributing
Issues and pull requests are welcome! Please test any changes by running:
```bash
nix build .#cursor
./result/bin/cursor --version
```
## 🔗 Related
- [Cursor Official Website](https://cursor.sh/)
- [NixOS Documentation](https://nixos.org/manual/nixos/stable/)
- [Nix Flakes Documentation](https://nixos.wiki/wiki/Flakes)