Metadata-Version: 2.4
Name: grimx
Version: 0.5.4
Summary: GCC Runtime & Installation Manager, Cross-platform — minimal tooling for C and C++ projects
License: MIT License
        
        Copyright (c) 2026 GRIMX LABS
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.1
Requires-Dist: tomlkit>=0.12
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Dynamic: license-file

# GRIMX

**GCC Runtime & Installation Manager - Cross Platform**

A minimal developer tool for reproducible C and C++ environments.

---

## Installation

```bash
pip install grimx
```

That's it. The `grimx` command is now available globally.

---

## Quick Start

```bash
grimx new hello_world
cd hello_world
grimx install fmt
grimx build
grimx test
grimx list
grimx clean
grimx doctor
grimx run
```

---

## Commands

| Command | Description |
|---|---|
| `grimx new <name>` | Scaffold a new project |
| `grimx new <name> --type c` | Scaffold a C project (default: cpp) |
| `grimx install <pkg>` | Install a dependency |
| `grimx install` | Restore all dependencies from lock file |
| `grimx build` | Build the project via CMake |
| `grimx test` | Run tests via CTest |
| `grimx list` | List installed locked packages |
| `grimx clean` | Clean build artifacts |
| `grimx clean --full` | Clean build and vcpkg_installed artifcats |
| `grimx run` | Run the compiled application |
| `grimx run -- <args>` | Run the application with arguments |
| `grimx doctor` | Diagnose the development environment |

---

## Project Structure

```
my_project/
  src/            source files
  include/        project headers
  tests/          unit tests
  cmake/          optional cmake modules
  CMakeLists.txt
  grimx.config
  grimx.lock
```

---

## Project Types

```bash
grimx new my_app --type c            # C application
grimx new my_app --type cpp          # C++ application (default)
grimx new my_fw  --type embedded-c   # Embedded C
grimx new my_fw  --type embedded-cpp # Embedded C++
```

---

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

---

## License

MIT — see [LICENSE](LICENSE).
