@niyantrilabs/spiritai 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +91 -42
  2. package/index.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,75 +2,124 @@
2
2
 
3
3
  **Mobile Autonomous Developer for Multi-Platform App Development**
4
4
 
5
- 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.
5
+ Spirit AI is an intelligent command-line interface agent that connects to your development server and enables autonomous mobile application development across Flutter, Android, iOS, React Native, and all major mobile frameworks.
6
6
 
7
- ## Features
7
+ ## Overview
8
8
 
9
- - 🤖 Autonomous mobile development across all platforms
10
- - 🔧 Full file system operations with surgical precision
11
- - 📱 Support for Flutter, Android (Kotlin/Java), iOS (Swift), React Native
12
- - 🔌 Real-time connection to development server
13
- - 🎯 Smart command execution with system awareness
14
- - 🔪 Advanced code editing capabilities (line-level precision)
9
+ Spirit AI provides developers with an advanced autonomous development environment capable of executing complex mobile development tasks across multiple platforms. The system offers real-time connectivity to development servers, intelligent code manipulation, and comprehensive system integration.
10
+
11
+ ## Key Capabilities
12
+
13
+ - Autonomous mobile application development across all major platforms
14
+ - Comprehensive file system operations with line-level precision editing
15
+ - Cross-platform support for Flutter, Android (Kotlin/Java), iOS (Swift/Objective-C), and React Native
16
+ - Real-time bidirectional communication with development servers
17
+ - Intelligent command execution with full system context awareness
18
+ - Advanced surgical code editing operations including targeted line modifications
15
19
 
16
20
  ## Installation
21
+
22
+ Install Spirit AI globally via npm:
17
23
  ```bash
18
24
  npm install -g @niyantrilabs/spiritai
19
25
  ```
20
26
 
21
- ## Usage
27
+ ## Getting Started
28
+
29
+ ### Basic Usage
30
+
31
+ Connect to your development server using a connection code:
22
32
  ```bash
23
- # Connect to your development server
24
33
  spiritai connect <your-connection-code>
34
+ ```
25
35
 
26
- # Show help
27
- spiritai --help
36
+ ### Command Reference
37
+ ```bash
38
+ spiritai connect <code> # Establish connection to development server
39
+ spiritai --help # Display help information
40
+ spiritai --version # Show version number
41
+ spirit connect <code> # Shorthand alias
42
+ ```
28
43
 
29
- # Show version
30
- spiritai --version
44
+ ## System Requirements
31
45
 
32
- # Using the shorter alias
33
- spirit connect <code>
34
- ```
46
+ - Node.js version 16.0.0 or higher
47
+ - Active internet connection for server communication
48
+ - Compatible operating system (Windows, macOS, or Linux)
49
+
50
+ ## Platform Support
51
+
52
+ Spirit AI is compatible with the following platforms:
53
+
54
+ - **macOS**: x64 and ARM64 architectures
55
+ - **Linux**: x64 and ARM64 architectures
56
+ - **Windows**: x64 and ARM64 architectures
35
57
 
36
- ## Requirements
58
+ ## Development Environment Detection
37
59
 
38
- - Node.js >= 16.0.0
39
- - Internet connection for server communication
60
+ Spirit AI automatically detects and reports the availability of the following development tools:
40
61
 
41
- ## Supported Platforms
62
+ - Java Runtime Environment and Java Development Kit
63
+ - Android Debug Bridge (ADB)
64
+ - Flutter SDK and Dart SDK
65
+ - Git version control system
66
+ - Node Package Manager (npm)
67
+ - Python interpreter and pip package manager
42
68
 
43
- - macOS (x64, arm64)
44
- - Linux (x64, arm64)
45
- - Windows (x64, arm64)
69
+ ## Interactive Commands
46
70
 
47
- ## Development Tools Detection
71
+ Once connected to a development server, the following commands are available:
48
72
 
49
- Spirit AI automatically detects and reports:
50
- - Java, ADB (Android development)
51
- - Flutter, Dart
52
- - Git, npm, Python, pip
73
+ - `status` - Display current connection status and system information
74
+ - `help` - Show available commands and usage instructions
75
+ - `exit` or `quit` - Terminate the agent session
76
+ - `clear` - Clear the terminal screen
53
77
 
54
- ## Commands
78
+ ## Advanced Features
55
79
 
56
- Once connected:
57
- - `status` - Show connection status
58
- - `help` - Show available commands
59
- - `exit` - Exit the agent
60
- - `clear` - Clear screen
80
+ ### Surgical Precision Code Editing
61
81
 
62
- ## Security Notice
82
+ Spirit AI supports advanced code manipulation operations:
63
83
 
64
- Spirit AI has full access to your file system and can execute shell commands. Only connect to trusted servers with valid connection codes.
84
+ - **DELETE_LINE** - Remove specific lines from source files
85
+ - **REPLACE_LINE** - Replace content at specific line numbers
86
+ - **INSERT_BEFORE** - Insert new lines before specified positions
87
+ - **INSERT_AFTER** - Insert new lines after specified positions
88
+ - **REMOVE_IMPORT** - Remove unused import statements
89
+ - **ADD_IMPORT** - Add missing import declarations
90
+
91
+ ### File System Operations
92
+
93
+ The agent provides comprehensive file system access including read, write, create, modify, and delete operations with full directory traversal capabilities.
94
+
95
+ ## Security Considerations
96
+
97
+ **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.
98
+
99
+ ## Technical Architecture
100
+
101
+ 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.
65
102
 
66
103
  ## License
67
104
 
68
- MIT
105
+ This project is licensed under the MIT License. See the LICENSE file for complete terms and conditions.
106
+
107
+ ## Maintainer
108
+
109
+ Developed and maintained by Niyantri Labs.
110
+
111
+ ## Source Code
112
+
113
+ The complete source code is available on GitHub:
114
+ https://github.com/niyantrilabs/spiritai
115
+
116
+ ## Support and Issues
69
117
 
70
- ## Author
118
+ For bug reports, feature requests, and technical support, please visit:
119
+ https://github.com/niyantrilabs/spiritai/issues
71
120
 
72
- Niyantri Labs
121
+ ## Version History
73
122
 
74
- ## Repository
123
+ Current stable release: 1.0.0
75
124
 
76
- https://github.com/niyantrilabs/spiritai
125
+ For detailed version history and release notes, refer to the project's GitHub releases page.
package/index.js CHANGED
@@ -1,4 +1,4 @@
1
- #!/usr/bin/env node
1
+ #!/usr/bin/env node
2
2
 
3
3
  const yargs = require('yargs/yargs');
4
4
  const { hideBin } = require('yargs/helpers');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@niyantrilabs/spiritai",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Spirit AI - Mobile Autonomous Developer for multi-platform app development",
5
5
  "main": "index.js",
6
6
  "bin": {