https://github.com/anaskalt/yoctoctl

Container orchestration CLI for managing Yocto development environments on Apple Silicon macOS

https://github.com/anaskalt/yoctoctl

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary

Keywords

apple apple-silicon cli crops docker gum macos poky shell yocto
Last synced: 5 months ago · JSON representation

Repository

Container orchestration CLI for managing Yocto development environments on Apple Silicon macOS

Basic Info
  • Host: GitHub
  • Owner: anaskalt
  • License: mit
  • Language: Shell
  • Default Branch: main
  • Homepage:
  • Size: 30.3 KB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Topics
apple apple-silicon cli crops docker gum macos poky shell yocto
Created 9 months ago · Last pushed 9 months ago
Metadata Files
Readme Changelog License

README.md

yoctoctl - Yocto Development Environment Manager

A comprehensive environment management tool for Poky CROPS development on Apple Silicon macOS, providing automated container orchestration, network configuration and seamless file system integration.

Overview

yoctoctl provides a streamlined interface for managing containerized Yocto Project development environments, specifically optimized for Apple Silicon Macs. It automates the complexity of container lifecycle management while providing seamless integration with macOS native tools.

Key Features

  • Automated Container Lifecycle Management - Intelligent orchestration of file server and build containers
  • Network Infrastructure Configuration - Automatic SMB endpoint setup for native macOS file access
  • Interactive Command Interface - Professional TUI powered by Charm's gum for intuitive operations
  • Real-time Environment Monitoring - Comprehensive health checks and status reporting
  • Persistent Storage Management - Shared volume architecture for efficient builds across projects

System Requirements

  • macOS on Apple Silicon (M1/M2/M3/M4)
  • Docker Desktop 4.0+ with Rosetta enabled
  • Homebrew package manager
  • Minimum 16GB RAM (8GB usable for Docker)
  • Minimum 100GB available disk space

Installation

Prerequisites

```bash

Install Homebrew if not already installed

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Install gum for UI components

brew install gum

Verify Docker Desktop is installed and running

docker --version ```

Installing yoctoctl

```bash

Download the latest release

sudo curl -L https://raw.githubusercontent.com/anaskalt/yoctoctl/main/yoctoctl -o /usr/local/bin/yoctoctl

Make executable

sudo chmod +x /usr/local/bin/yoctoctl

Verify installation

yoctoctl version ```

Quick Start

Note: First-time users must build the container infrastructure. See the Yocto Development Environment for Apple Silicon guide for detailed instructions.

```bash

Initialize and start the development environment

yoctoctl start

Check environment status

yoctoctl status

Connect to the development shell

yoctoctl shell

Access files via Finder

open "smb://127.0.0.2/workdir" ```

Usage

Interactive Mode

Launch without arguments for the interactive menu:

bash yoctoctl

Command Line Mode

```bash yoctoctl [command]

Commands: status Display comprehensive environment status start Initialize and start Yocto containers shell Connect to Poky development container shutdown Stop all containers gracefully version Display version information help Show help message ```

Container Architecture

The system manages two primary containers:

  1. yocto-fileserver - Samba server providing SMB access to the workspace
  2. yocto-builder - Poky CROPS environment for Yocto builds

Both containers share a persistent Docker volume (yocto-workspace) ensuring data preservation across sessions.

Documentation

Troubleshooting

Common Issues

Docker daemon not running ```bash

Start Docker Desktop application

open -a Docker ```

Network alias already exists ```bash

The tool handles this automatically, but you can manually clear:

sudo ifconfig lo0 -alias 127.0.0.2 ```

Permission denied on script execution ```bash

Ensure proper permissions

sudo chmod +x /usr/local/bin/yoctoctl ```

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

Author

Anastasios Kaltakis
GitHub: @anaskalt

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Charm for the excellent gum TUI framework
  • CROPS for Poky container images
  • ejaaskel for exceptional work supporting Yocto on Apple Silicon Macs
  • The Yocto Project community

Owner

  • Name: Anastasios Kaltakis
  • Login: anaskalt
  • Kind: user
  • Location: Athens

GitHub Events

Total
  • Release event: 1
  • Push event: 2
  • Pull request review event: 1
  • Pull request event: 3
  • Create event: 2
Last Year
  • Release event: 1
  • Push event: 2
  • Pull request review event: 1
  • Pull request event: 3
  • Create event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 5
  • Total Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 5
  • Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Anastasios Kaltakis a****s@g****m 5

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 6 minutes
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 6 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • anaskalt (4)
Top Labels
Issue Labels
Pull Request Labels