Have you ever wanted to push your script files from your computer to Roblox Studio directly?
Well with CreeperCLI, you can do that. It’s extremely simple, and it’s easier to use than Rojo.
Supported Operating Systems
Windows → Full (Tested) Linux → Full (Partially Tested) MacOS → Existing binaries (Untested)
Supported FileTypes
Anything that says .luau works with .lua as well, but I suggest .luau files since they have better language servers for Roblox-specific needs.
*.luau-----------------> ModuleScript
*.server.luau------> Script
*.client.luau------> LocalScript
*.json----------------> ModuleScript
*.toml----------------> ModuleScript
How do I use it?
It’s really simple. You can use any text editor you like (even Notepad).
Get the latest release of the .exe/binary file. By going to the Releases tab. (Or from the source code)
To update the .exe file, just use this command: creeper_cli.exe update (Might not work properly please use a package manager or install manually)
To create a new project, call creeper_cli.exe init or scroll down.
Running
Create an empty folder
Put the .exe inside it (Better alternatives rokit/aftman/foreman or PATH)
Run creeper_cli.exe init to create a new project. ( Scroll down for more info )
Run the .exefirst.
Open the plugin from the Plugins tab, and click Connect.
Info
Attempting to connect the plugin before running the server will result in an error.
Disconnect vs. Connected:
=-------->
Game / Tree / Root
CreeperCLI, like the Roblox Explorer, uses a tree to translate files to studio.
The game is the root of the Tree. (You can change it in creeper.toml)
Folders inside of it will match perfectly to those in Studio.
For Example:
"game"
-- ServerScriptService
- Hello.server.luau
It would get translated to this in studio ------------>
Initializing a Project
You can use the init command on the creeper_cli binary. This will create a default ‘base project’ which you can use to quickly get started with creeper_cli. (Otherwise just add a game folder and creeper.toml and everything will work perfectly fine.)
(Note: src at the end is optional, and the src directory will be named game by default. See Below.)
“I use Rojo a lot and would like to try CreeperCLI.”
Fear not, by adding src at the end of the command will rename the game directory made by default to src. (This also changes for the creeper.toml)
Custom Object Creation
You can name a folder name.ClassName with the name and class of the object respectively to create an object of that type. For example: object.ClickDetector would make a ClickDetector named ‘Object’.
HOW TO USE VIDEO
Visual Studio Integration
Install the Luau Language Server extension from JohnnyMorganz on Visual Studio Code (VS community works too). CreeperCLI will automatically generate a sourcemap and project json for intellisense.
That’s nice. I like that it is simple. If I didn’t have all the Rojo things set up for scripting, I would have used it. And by the way, the UI is, as always, top tier.
CreeperCLI now supports .json files.
It will try to convert your JSON into a module script that returns a table.
Json
Module
Useful in some cases, but you’ll need to call require if you want to access the contents through script. You can get the plugin from the creator hub and release executable from github.
hey, my team and I have designed the “GitHub” badge that you have in your post. please ask for permission next time when using someone else’s work; there is no license specified which means we get full ownership.
Hey sorry about using your GitHub badge/button.
I could remove it if you want, although I did make the Wally/Library buttons myself, inspired from the Github badge. (I also used it on another post, sorry about that too)
I’m going to be honest. But while asking for permission is a good idea, it’s not necessary, at least not for a github badge that has one half transparent line, text, and an icon.
If I made something similar, I probably wouldn’t care at all; I would’ve been happy that it’s being used elsewhere. So, ultimately, it’s up to the person using it to ask for permission or not. And also, the GitHub badge that y’all have designed does not meet the threshold of originality to say you have full ownership. It’s pretty much just this; the only difference is that it has rounded corners, a line for separation and an outline, which can be made in 30 seconds more or less.
Not saying asking for permission is a bad idea or they shouldn’t do it; it just… wouldn’t be necessary. Again, I’ll really only be happy with the fact that somebody liked it enough to use it if I were you.
I also want to know, would aftman package support be useful for CreeperCLI?
I’m not sure how useful it would be. CreeperCLI is as simple as 2 steps, download and run the exe.
(Ignoring the plugin installation, which you only need once)
There’s almost no need for this to have a toolchain package, but I want to hear out what others think.
Only new (edited) files will be sent back through the request, instead of every single file in all folders.
This ensures that I get the ability to delete files and update things from roblox-and-back.
There’s also a video on the main post so you can link people to that too.
Toml Support
=--------->
You can use both .json and .toml files for data.
Files update when changed
Apart from updating when initially connecting to the server, files will only update when they are edited. If you delete a file, and then edit it back, the server will force a recreation of the file with the new content.
Server / exe changes
Some slice-of-life changes, other things, memory management.
creeper.toml Support
You can now create a creeper.toml file in the same directory as where creeper_cli.exe is located.
It’s really limited right now, but there will be more things and settings in the future where this can come in handy.
Changing server ports
You can write port = 1234 to switch the port to 1234 for example.
Keep in mind that the port in the creeper.toml must be the same one on the textbox in the plugin =-------------------->
I’m thinking of adding more to this, like how deletion is handled, stuff relating to team create accessibility etc. Also, someone suggested that I should add a way to set custom file paths for folders, so that’ll be done through the toml too.
)
