@xaidenlabs/uso 1.0.2 → 1.1.0

package/README.md

@@ -1,97 +1,133 @@
-# 🦀 USO ☀️
-### The **Magic Button** for Solana! ✨
+# Universal Solana Orchestrator (USO)
 
-Do you want to build cool blockchain apps on Solana? 
-Usually, installing all the tools is super hard and boring. 
-**USO does it all for you with just ONE CLICK!**
+The Universal Solana Orchestrator (USO) is a command-line interface designed to streamline the initialization and management of Solana development environments. By automating the installation of the Rust toolchain, Solana CLI, and Anchor framework, USO eliminates the complexity often associated with setting up a Web3 development workspace on Windows, macOS, and Linux.
+
+This tool is engineered to support developers at all levels—from beginners setting up their first environment to senior engineers managing multiple workstations.
 
 ---
 
-## 🚀 Step 1: Get USO
-First, let's put USO on your computer.Open your **Terminal** (or Command Prompt) and type this magic spell:
+## Installation
+
+Install USO globally using NPM. This ensures the CLI is accessible from any terminal directory.
 
 ```bash
 npm install -g @xaidenlabs/uso
 ```
-*(If that doesn't work, ensure you have Node.js installed!)*
+
+**Prerequisites:**
+- **Node.js**: Ensure Node.js is installed on your system.
+- **Administrator Privileges**: Some installation steps (successfully creating symlinks, updating system PATH) may require elevated permissions.
 
 ---
 
-## 🩺 Step 2: Check Your Computer
-Is your computer ready? Ask the Doctor!
+## Usage
+
+### System Diagnostics
+
+Before attempting installation, you can run a diagnostic check to evaluate the current state of your environment.
+
 ```bash
 uso doctor
 ```
-It will check everything for you.
-- ✅ means GOOD!
-- ❌ means MISSING (Don't worry, USO will fix it!)
+
+This command will inspect your system for existing installations of Git, Rust, Solana CLI, and Anchor.
 
 ---
 
-## ✨ Step 3: Install Everything!
-This is the best part. To install **Rust**, **Solana**, and **Anchor** all at once, just type:
+### Full Environment Setup
+
+To perform a complete installation of the entire stack (Rust, Solana, Anchor), use the initialization command:
+
 ```bash
 uso init
 ```
-- It will download everything.
-- It might ask for permission (click **Yes**!).
-- **IMPORTANT**: When it's done, close your terminal and open it again!
+
+The installer will:
+1.  Detect your operating system.
+2.  Check for necessary build tools (C++ Build Tools on Windows).
+3.  Download and install the Rust toolchain (via `rustup`).
+4.  Install the Solana CLI (Agave release).
+5.  Build and install the Anchor Version Manager (AVM) and Anchor Framework.
+6.  Generate a new Solana wallet if one is not detected.
+
+**Note:** You may be prompted to approve administrative access during the installation of specific components.
 
 ---
 
-## 🎯 Step 4: Install Just One Thing (Optional)
-Maybe you only want one toy? You can do that too!
+### Granular Installation
 
-- **Want just Rust?** 🦀
-  ```bash
-  uso install rust
-  ```
+Use the `install` command to set up individual components if you do not require the full stack.
 
-- **Want just Solana?** ☀️
-  ```bash
-  uso install solana
-  ```
+**Install Rust:**
+```bash
+uso install rust
+```
 
-- **Want just Anchor?** ⚓
-  ```bash
-  uso install anchor
-  ```
+**Install Solana CLI:**
+```bash
+uso install solana
+```
+
+**Install Anchor Framework:**
+```bash
+uso install anchor
+```
 
 ---
 
-## ✅ Step 5: Test It!
-Let's make sure everything works perfectly.
+---
+
+### Project Scaffolding
+
+Start a new project with a robust, pre-configured Anchor template.
+
 ```bash
-uso verify
+uso create <project-name>
 ```
-If this says "Success", you are ready to build the future! 🚀
+
+This generates a "batteries-included" workspace with:
+-   **Localnet Configuration**: `Anchor.toml` pre-wired for local development.
+-   **Test Suite**: A running example test file using the latest Anchor syntax.
+-   **Scripts**: NPM scripts for linting and testing.
 
 ---
 
-## 🗑️ Step 6: Removing It (Uninstall)
-If you don't want these tools anymore, USO can clean up for you.
+### Verification
 
-- **Remove Everything:**
-  ```bash
-  uso uninstall
-  ```
-  *(Be careful! It might ask to delete your wallet with your crypto keys!)*
+After installation, verify that all components are correctly configured and accessible in your system PATH.
+
+```bash
+uso verify
+```
 
-- **Remove Just One Thing:**
-  ```bash
-  uso uninstall solana
-  ```
+This process will validate the version of each tool and ensure the environment is ready for development.
 
 ---
 
-## ❓ Help! It's not working!
+## Uninstallation
+
+USO provides a clean uninstallation process to remove the installed toolchains.
+
+**Remove All Components:**
+```bash
+uso uninstall
+```
+
+**Remove Individual Components:**
+```bash
+uso uninstall solana
+uso uninstall rust
+uso uninstall anchor
+```
+
+---
 
-**"Permission Denied" or "Error"?**
-- Try running your terminal as **Administrator** (Right-click -> Run as Administrator).
+## Troubleshooting
 
-**"Command not found"?**
-- Did you close and reopen your terminal after installing? Do that now!
+-   **"Permission Denied" Errors**: If you encounter errors related to permissions or symlinks, try running your terminal as an Administrator.
+-   **"Command Not Found"**: After installation, your system PATH is updated. You must restart your terminal (close and reopen) for these changes to take effect.
+-   **Windows Build Tools**: If Rust fails to install on Windows, ensure you have the "Desktop development with C++" workload installed via Visual Studio Build Tools.
 
 ---
 
-**Made with ❤️ for You.**# cli-
+**Developed by Xaiden Labs**

package/bin/index.js

@@ -1,8 +1,9 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 const { program } = require('commander');
 const { init } = require('../src/commands/init');
 const { doctor } = require('../src/commands/doctor');
 const { verify } = require('../src/commands/verify');
+const { create } = require('../src/commands/create');
 const { build, test, deploy, clean } = require('../src/commands/workflow');
 const { uninstall } = require('../src/commands/uninstall');
 
@@ -27,6 +28,11 @@ program
     .description('Verify installation by building a test Anchor project')
     .action(verify);
 
+program
+    .command('create <project_name>')
+    .description('Scaffold a new Anchor project')
+    .action(create);
+
 program
     .command('build')
     .description('Build the Anchor project (wraps "anchor build")')

package/my-test-project/Anchor.toml

@@ -0,0 +1,18 @@
+[toolchain]
+
+[features]
+seeds = false
+skip-lint = false
+
+[programs.localnet]
+my_test_project = "Fg6PaFpoGXkYsidMpWTK6W2BeZ7FEfcYkg476zPFsLnS"
+
+[registry]
+url = "https://api.apr.dev"
+
+[provider]
+cluster = "Localnet"
+wallet = "~/.config/solana/id.json"
+
+[scripts]
+test = "yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/**/*.ts"

package/my-test-project/README.md

@@ -0,0 +1,36 @@
+# Welcome to Your USO Project 🚀
+
+Congratulations! You've just scaffolded a professional Solana workspace using the **Universal Solana Orchestrator (USO)**.
+
+This isn't just a folder with files. It's a battle-tested setup ready for serious development.
+
+## 📂 Structure
+- `programs/`: Your Rust smart contracts live here.
+- `tests/`: Robust TypeScript tests using Anchor.
+- `Anchor.toml`: Your project configuration.
+
+## ⚡ Quick Start
+
+### 1. Build
+Compile your smart contract:
+```bash
+anchor build
+```
+
+### 2. Test
+Run your test suite against a local validator:
+```bash
+anchor test
+```
+*Note: This automatically spins up a local validator, deploys your program, runs tests, and shuts down.*
+
+### 3. Deploy (Devnet)
+When you're ready to go public:
+1. Switch to devnet: `solana config set --url devnet`
+2. Airdrop SOL: `solana airdrop 2`
+3. Deploy: `anchor deploy`
+
+## 🧠 Need Help?
+Run `uso doctor` if your environment feels weird. Usage instructions are also available via `uso help`.
+
+Happy coding!