Sign in Get started

project-conventions - Skill - OpenSmartRoute

Skillv1.0.0

project-conventions

Core project conventions for Buoy

by wilfriedE(0) 0 installs

Free

Sign in to install

Free account. Installing gives you the manifest plus copy-paste snippets.

About

Instruction file imported from wilfriedE/buoy (.cursor/rules/project-conventions.mdc). Copyright stays with the author.

Buoy Project Conventions

Build & Scripts

UV manages Python scripts. Use uv run <command> for: build, download-base, build-image, create-manifest
Build outputs go to build/ (gitignored): buoy_build.img, docker_images.tar, buoy.rpi-imager-manifest
Base images go to image/base/ (gitignored). Download via uv run download-base
Shell scripts in image/ handle low-level ops (Docker, chroot, parted). Python wrappers in image/*.py expose them as UV entry points

Tech Stack

Ansible for Pi configuration (playbook runs on first boot)
Docker for ROS 2 (rosbridge); host networking for DDS multicast
hostapd + dnsmasq for WiFi AP (native, not Docker)
Node.js for command center (pnpm)

Key Paths

ansible/group_vars/all.yml – hostname, WiFi, ROS, ports
ansible/playbook.yml – role order
image/build-with-docker.sh – main build script (called by uv run build-image)
docker/compose.yml – ROS container definition

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/wilfriede-buoy-project-conventions-rule/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

wilfriede-buoy-project-conventions-rule.ocm.jsonjson

{
  "ocm": "1",
  "id": "wilfriede-buoy-project-conventions-rule",
  "kind": "skill",
  "name": "project-conventions",
  "description": "Core project conventions for Buoy",
  "publisher": "wilfriedE",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "github-cursor-rules"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Core project conventions for Buoy"
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-cursor-rules",
      "repository": "https://github.com/wilfriedE/buoy",
      "path": ".cursor/rules/project-conventions.mdc",
      "ref": "9baf1061bfca1c2a3c2f24253562c1727908586e",
      "url": "https://github.com/wilfriedE/buoy/blob/9baf1061bfca1c2a3c2f24253562c1727908586e/.cursor/rules/project-conventions.mdc",
      "key": "wilfriedE/buoy/.cursor/rules/project-conventions.mdc"
    }
  },
  "instructions": "# Buoy Project Conventions\n\n## Build & Scripts\n\n- **UV** manages Python scripts. Use `uv run <command>` for: `build`, `download-base`, `build-image`, `create-manifest`\n- **Build outputs** go to `build/` (gitignored): `buoy_build.img`, `docker_images.tar`, `buoy.rpi-imager-manifest`\n- **Base images** go to `image/base/` (gitignored). Download via `uv run download-base`\n- **Shell scripts** in `image/` handle low-level ops (Docker, chroot, parted). Python wrappers in `image/*.py` expose them as UV entry points\n\n## Tech Stack\n\n- **Ansible** for Pi configuration (playbook runs on first boot)\n- **Do",
  "cost": {
    "context_tokens": 251
  }
}

Fetch it by URL: GET /api/v1/registry/wilfriede-buoy-project-conventions-rule/manifest?version=1.0.0