Skip to main content

Command line tools for the Graft game engine

Project description

Graft CLI

Command line tools for creating and managing projects built with the Graft game engine.

Graft CLI helps you create new projects, run them locally, install specific engine versions, and work with project templates.

This tool is designed to stay lightweight and simple while the Graft ecosystem grows.


Installation

Install with pip

pip install graft-engine-cli

Or install locally from source:

pip install .

Basic Usage

Running the CLI with no arguments will display available commands:

graft

Output:

Graft CLI
Usage:
     graft new [name] [--engine VERSION]
     graft run
     graft clone <repo>
     graft doctor
     graft engines
     graft version

Commands

Create a New Project

Create a new Graft project:

graft new MyGame

Create using a specific engine version:

graft new MyGame --engine 0.0.6

Initialize a project in the current directory:

graft new .

Run a Project

Run the current project:

graft run

The CLI will automatically:

  • locate the project root
  • read the entry point from project.graft
  • run the Graft engine

Older engine versions are automatically supported.


Clone a Template

Clone a project template:

graft clone https://github.com/user/template

Templates should include a project.graft file.


List Engine Versions

View available Graft engine versions:

graft engines

Example output:

Available Graft Versions:

0.0.1
0.0.2
0.0.3
0.0.4
0.0.5
0.0.6

Latest: 0.0.6

Environment Diagnostics

Check your development environment:

graft doctor

This verifies tools required by Graft such as:

  • Python
  • Git
  • Rust
  • Cargo

CLI Version

Display the installed CLI version:

graft version

Project Structure

A typical Graft project looks like:

MyGame/
├ engine/
├ scripts/
│  └ main.lua
├ assets/
└ project.graft

Example project.graft:

name = "MyGame"
entry = "scripts/main.lua"

Engine Versions

The CLI installs engine versions directly from the official repository:

https://github.com/phaedalus/graft

Projects can target specific engine releases for stability.


Philosophy

Graft is designed with a simple philosophy:

  • Rust for performance
  • Lua for gameplay scripting
  • Minimal core
  • Fork-per-project engine architecture

The CLI reflects this philosophy by staying small and predictable.


License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

graft_engine_cli-0.0.2.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

graft_engine_cli-0.0.2-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file graft_engine_cli-0.0.2.tar.gz.

File metadata

  • Download URL: graft_engine_cli-0.0.2.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for graft_engine_cli-0.0.2.tar.gz
Algorithm Hash digest
SHA256 c7b4c047eff3d4ddda24bcced9ef8870bfd8434c2fbfa012ce1cbe022b98bf50
MD5 bc96882798a3f5f9cbe528b6c87fe9f9
BLAKE2b-256 153bd06a24d6091b8dace006a5fa55ac63eb3913fb0efda8bdd743e162233aee

See more details on using hashes here.

File details

Details for the file graft_engine_cli-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for graft_engine_cli-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aff81cc53da7b876abfe348f299ee7e885b8c9a1d214b68fdcc34bfb72d6d202
MD5 5e8ed767179bf2c3d523701552f6154a
BLAKE2b-256 ec214225d7cbdb05d5cade4fb06b998729fc92ae7273df9ed9aab3174e4d8d82

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page