Skip to content

akuroiwa/gemini-jscad

Repository files navigation

gemini-jscad

A Gemini CLI extension for real-time 3D preview of JSCAD models, with a Gemini-managed workflow.

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.

Features

  • Gemini-Managed Preview Server: Gemini starts, stops, and checks the status of the preview server based on your requests.
  • Live Interactive Viewer: The server provides a live preview where you can rotate, pan, and zoom the 3D model.
  • Simplified Setup: A postinstall script automatically copies all necessary configuration and instruction files.
  • Robust Workflow: The workflow is defined in GEMINI.md, ensuring Gemini can manage the server lifecycle reliably.

Installation

This tool is intended for global installation.

npm install -g gemini-jscad-tool

That's it. The installation script automatically handles the following:

  • Makes the gemini-jscad-server command globally available.
  • Copies the extension configuration (gemini-extension.json) and the instruction manual (GEMINI.md) to your Gemini settings directory (~/.gemini/extensions/jscad/).

Usage

The workflow is a conversation between you and Gemini. You give high-level commands, and Gemini follows its instructions to manage the toolchain.

Step 1: Start the Preview Server

To begin, ask Gemini to start the server.

You: "Start the preview server."

Gemini will start the server in the background and inform you. You can then open http://localhost:3000 to see the viewer.

Step 2: Create Models

Now, ask Gemini to create any JSCAD model. If the server isn't running, Gemini will automatically start it for you and let you know.

You: "Create a 20mm cube."

Step 3: Stop the Preview Server

When you are finished, it is important to ask Gemini to stop the server to prevent orphaned processes.

You: "Stop the preview server."

This ensures a clean shutdown.

About

A Gemini CLI extension for real-time 3D preview of JSCAD models.

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors