🪼 Jelly

Getting Started

⚠️ Beta Release Notice

Jelly is currently in beta (v0.3). While functional, expect some rough edges and breaking changes. Feedback and contributions are welcome!

Installation

Choose the method that works best for your setup:

Using Rokit (recomended)

  • Add and install:

    rokit add OMouta/Jelly

Using Aftman (deprecated)

  • Add Jelly to your aftman.toml:

    aftman add OMouta/Jelly

  • Then install:

    aftman install

Manual

  • Go to the latest GitHub release
  • Download the executable for your platform

Creating Your First Project

Initialize a new Jelly project in your current directory:

jelly init --name my-roblox-game

This creates a jelly.json file with basic project configuration:

{
  "name": "my-roblox-game",
  "version": "1.0.0",
  "dependencies": {}
}

Adding Dependencies

Add packages to your project using the jelly add command:

# Add a single package
jelly add omouta/roact

# Add multiple packages
jelly add roblox/roact roblox/rodux

# Add with specific version
jelly add roblox/roact@^1.4.0

# Add as dev dependency
jelly add -D roblox/testez

Installing Dependencies

Install all dependencies listed in your jelly.json:

jelly install

This creates a jelly-lock.json file to ensure reproducible installs and downloads packages to the Packages directory.

Basic Commands

Package Management

  • jelly init --name <name> - Initialize new project
  • jelly install - Install dependencies
  • jelly add <package> - Add package
  • jelly remove <package> - Remove package
  • jelly update [packages...] - Update packages
  • jelly exec <package> [args...] - Execute binary packages (checks local first, then downloads)

Discovery & Information

  • jelly search <query> - Search packages
  • jelly info <package> - Package information
  • jelly list - List installed packages

Utility Commands

  • jelly run <script> - Run project scripts
  • jelly clean - Clean packages directory
  • jelly outdated - Check for outdated packages

Next Steps

Now that you have Jelly installed, explore these topics: