STAR CLI Documentation

📋 Overview

The STAR CLI (Command Line Interface) is the most important tool for developers working with the OASIS ecosystem. It provides comprehensive command-line access to all STARNET functionality, including STARNETHolon management, DNA system operations, and dependency management.

🎯 Key Features

STARNETHolon Management

  • Create, Edit, Delete: Full CRUD operations for all STARNETHolon types

  • Publish & Download: Publish to STARNET and download from others

  • Version Control: Manage versions and rollbacks

  • Search & Discovery: Find and explore STARNETHolons

DNA System

  • Dependency Management: Link any STARNETHolon to any other STARNETHolon

  • DNA Generation: Automatic DNA file creation and management

  • Dependency Resolution: Handle complex dependency chains

  • Metadata Management: Advanced metadata system integration

STARNETHolon Types

  • OAPPs: OASIS Applications

  • Templates: Application templates

  • Runtimes: Execution environments

  • Libraries: Code libraries and frameworks

  • NFTs: Non-fungible tokens

  • GeoNFTs: Location-based NFTs

  • GeoHotSpots: Geographic interaction points

  • Quests: Game quests and objectives

  • Missions: Mission system

  • Chapters: Story chapters

  • InventoryItems: Game items and rewards

  • CelestialSpaces: Virtual spaces

  • CelestialBodies: Virtual worlds

  • Zomes: Code modules

  • Holons: Data objects

  • MetaData: CelestialBodies, Zomes, and Holons metadata

🚀 Getting Started

Installation

First Run

🎮 Main Commands

System Commands

  • ignite - Ignite STAR & Boot The OASIS

  • extinguish - Extinguish STAR & Shutdown The OASIS

  • help [full] - Show help page (full shows all sub-commands)

  • version - Show versions of STAR ODK, COSMIC ORM, OASIS Runtime & Providers

  • status - Show the status of STAR ODK

  • exit - Exit the STAR CLI

Core Development Commands

  • light - Creates a new OAPP (Zomes/Holons/Star/Planet/Moon) at the given genesis folder location

  • light wiz - Start the Light Wizard

  • light transmute - Creates a new Planet (OApp) from hApp DNA

  • bang - Generate a whole metaverse or part of one (Multiverses, Universes, Dimensions, etc.)

  • wiz - Start the STAR ODK Wizard for creating tailored OAPPs

OAPP Management Commands

  • seed - Deploy/Publish an OAPP to the STARNET Store

  • unseed - Undeploy/Unpublish an OAPP from the STARNET Store

  • reseed - Redeploy/Republish an OAPP to the STARNET Store

  • dust - Delete an OAPP (removes from STARNET if published)

  • radiate - Highlight the OAPP in the STARNET Store (Admin/Wizards Only)

  • emit - Show how much light the OAPP is emitting (karma score)

  • reflect - Show stats of the OAPP

  • evolve - Upgrade/update an OAPP

  • mutate - Import/Export hApp, dApp & others

  • love - Send/Receive Love for an avatar

  • burst - View network stats/management/settings

  • super - Reserved For Future Use

  • net - Launch the STARNET Library/Store

  • gate - Opens the STARGATE to the OASIS Portal

  • api [oasis] - Opens the WEB5 STAR API (or WEB4 OASIS API if oasis included)

🚀 Getting Started

Installation

First Run

🏗️ STARNETHolon Operations

OAPP Commands

hApp Commands

Runtime Commands

Library Commands

Celestial Space Commands

Celestial Body Commands

Zome Commands

Holon Commands

Quest System Commands

NFT Commands

Plugin Commands

Avatar Commands

Karma Commands

Keys Commands

Wallet Commands

Map Commands

SEEDS Commands

Data Commands

OLAND Commands

ONODE Commands

HyperNET Commands

ONET Commands

Configuration Commands

Testing Commands

🔗 Dependency Management

Understanding Dependencies

The DNA system allows ANY STARNETHolon to depend on ANY other STARNETHolon:

Adding Dependencies

Removing Dependencies

🧬 DNA System

DNA File Structure

DNA Operations

🔍 Search and Discovery

Search Commands

List Commands

📊 Version Management

Version Operations

Publishing Versions

🎮 Advanced Features

Batch Operations

Template Operations

Metadata Operations

🔧 Configuration

CLI Configuration

Avatar Management

📈 Analytics and Monitoring

Usage Statistics

Performance Monitoring

🚀 Best Practices

Development Workflow

  1. Plan Dependencies: Map out required STARNETHolons

  2. Create Base Components: Start with foundational STARNETHolons

  3. Build Dependencies: Create dependent STARNETHolons

  4. Test Integration: Verify all dependencies work

  5. Publish System: Publish complete system to STARNET

Dependency Management

  • Keep Dependencies Minimal: Only include necessary dependencies

  • Use Semantic Versioning: Follow versioning best practices

  • Document Dependencies: Clearly document why each dependency exists

  • Test Dependency Changes: Verify changes don't break dependent STARNETHolons

DNA Best Practices

  • Regular DNA Updates: Keep DNA files current

  • Version Control: Track DNA file changes

  • Backup DNA: Maintain DNA file backups

  • Validate DNA: Ensure DNA files are valid

🆘 Troubleshooting

Common Issues

Debug Mode

📚 Integration with STARNET Web UI

CLI to Web UI

  • CLI Operations: All CLI operations are reflected in the Web UI

  • Real-time Sync: Changes appear immediately in the Web UI

  • Cross-Platform: Use CLI and Web UI interchangeably

Web UI to CLI

  • Export Operations: Export from Web UI for CLI use

  • Import Operations: Import CLI-created STARNETHolons

  • Synchronization: Keep both interfaces in sync

📞 Support and Resources

Documentation

Community Support


The STAR CLI is the most powerful tool for developers working with the OASIS ecosystem, providing complete control over STARNETHolons and their dependencies.

Last updated