@niyantrilabs/spiritai 1.0.1 → 1.0.3

package/README.md

@@ -1,76 +1,118 @@
 # Spirit AI
 
-**Mobile Autonomous Developer for Multi-Platform App Development**
+**Autonomous Developer for Multi-Platform Development**
 
-Spirit AI is an intelligent CLI agent that connects to your development server and enables autonomous mobile application development across Flutter, Android, iOS, React Native, and all major mobile frameworks.
+Spirit AI is an agentic development tool that lives in your terminal, understands your development environment, and helps you build faster by executing complex tasks, managing file operations, and handling development workflows -- all through natural language commands via your connected development server.
 
-## Features
+## Overview
 
-- 🤖 Autonomous mobile development across all platforms
-- 🔧 Full file system operations with surgical precision
-- 📱 Support for Flutter, Android (Kotlin/Java), iOS (Swift), React Native
-- 🔌 Real-time connection to development server
-- 🎯 Smart command execution with system awareness
-- 🔪 Advanced code editing capabilities (line-level precision)
+Spirit AI connects to your development server and acts as an intelligent agent capable of understanding your codebase, executing development tasks, and managing your entire development workflow. The system provides real-time bidirectional communication, intelligent code manipulation, and comprehensive system integration.
+
+## Key Capabilities
+
+- Autonomous code generation and modification across your entire project
+- Surgical precision file operations with line-level editing accuracy
+- Real-time bidirectional communication with development servers
+- Intelligent command execution with full system context awareness
+- Advanced code editing operations including targeted modifications
+- Comprehensive development environment detection and integration
 
 ## Installation
+
+Install Spirit AI globally via npm:
 ```bash
 npm install -g @niyantrilabs/spiritai
 ```
 
-## Usage
+## Getting Started
+
+### Basic Usage
+
+Connect to your development server using a connection code:
 ```bash
-# Connect to your development server
 spiritai connect <your-connection-code>
+```
 
-# Show help
-spiritai --help
+### Command Reference
+```bash
+spiritai connect <code>    # Establish connection to development server
+spiritai --help            # Display help information
+spiritai --version         # Show version number
+spirit connect <code>      # Shorthand alias
+```
 
-# Show version
-spiritai --version
+## System Requirements
 
-# Using the shorter alias
-spirit connect <code>
-```
+- Node.js version 16.0.0 or higher
+- Active internet connection for server communication
+- Compatible operating system (Windows, macOS, or Linux)
+
+## Platform Support
+
+Spirit AI is compatible with the following platforms:
 
-## Requirements
+- **macOS**: x64 and ARM64 architectures
+- **Linux**: x64 and ARM64 architectures  
+- **Windows**: x64 and ARM64 architectures
 
-- Node.js >= 16.0.0
-- Internet connection for server communication
+## Development Environment Detection
 
-## Supported Platforms
+Spirit AI automatically detects and reports the availability of development tools in your environment, including version control systems, package managers, programming language runtimes, and development frameworks.
 
-- macOS (x64, arm64)
-- Linux (x64, arm64)
-- Windows (x64, arm64)
+## Interactive Commands
 
-## Development Tools Detection
+Once connected to a development server, the following commands are available:
 
-Spirit AI automatically detects and reports:
-- Java, ADB (Android development)
-- Flutter, Dart
-- Git, npm, Python, pip
+- `status` - Display current connection status and system information
+- `help` - Show available commands and usage instructions
+- `exit` or `quit` - Terminate the agent session
+- `clear` - Clear the terminal screen
 
-## Commands
+## Advanced Features
 
-Once connected:
-- `status` - Show connection status
-- `help` - Show available commands
-- `exit` - Exit the agent
-- `clear` - Clear screen
+### Surgical Precision Code Editing
 
-## Security Notice
+Spirit AI supports advanced code manipulation operations:
 
-Spirit AI has full access to your file system and can execute shell commands. Only connect to trusted servers with valid connection codes.
+- **DELETE_LINE** - Remove specific lines from source files
+- **REPLACE_LINE** - Replace content at specific line numbers
+- **INSERT_BEFORE** - Insert new lines before specified positions
+- **INSERT_AFTER** - Insert new lines after specified positions
+- **REMOVE_IMPORT** - Remove unused import statements
+- **ADD_IMPORT** - Add missing import declarations
+
+### File System Operations
+
+The agent provides comprehensive file system access including read, write, create, modify, and delete operations with full directory traversal capabilities.
+
+## Security Considerations
+
+**Important Notice**: Spirit AI operates with full file system access privileges and can execute arbitrary shell commands on the host system. Users should only establish connections to trusted development servers using verified connection codes. All operations are performed with the permissions of the user executing the agent.
+
+## Technical Architecture
+
+Spirit AI utilizes Socket.IO for real-time bidirectional communication, yargs for command-line argument parsing, and Node.js native modules for system integration and file operations.
 
 ## License
 
-MIT
+This project is licensed under the MIT License. See the LICENSE file for complete terms and conditions.
+
+## Maintainer
+
+Developed and maintained by Niyantri Labs.
+
+## Source Code
+
+The complete source code is available on GitHub:  
+https://github.com/niyantrilabs/spiritai
+
+## Support and Issues
 
-## Author
+For bug reports, feature requests, and technical support, please visit:  
+https://github.com/niyantrilabs/spiritai/issues
 
-Niyantri Labs
+## Version History
 
-## Repository
+Current stable release: 1.0.2
 
-https://github.com/niyantrilabs/spiritai
+For detailed version history and release notes, refer to the project's GitHub releases page.

package/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const yargs = require('yargs/yargs');
 const { hideBin } = require('yargs/helpers');

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@niyantrilabs/spiritai",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Spirit AI - Mobile Autonomous Developer for multi-platform app development",
   "main": "index.js",
   "bin": {
-    "spiritai": "./index.js",
-    "spirit": "./index.js"
+    "spiritai": "index.js",
+    "spirit": "index.js"
   },
   "scripts": {
     "start": "node index.js",
@@ -43,7 +43,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/niyantrilabs/spiritai.git"
+    "url": "git+https://github.com/niyantrilabs/spiritai.git"
   },
   "bugs": {
     "url": "https://github.com/niyantrilabs/spiritai/issues"