@niyantrilabs/spiritai 1.0.2 → 1.0.4

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 (2) hide show
  1. package/README.md +34 -95
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,125 +1,64 @@
1
1
  # Spirit AI
2
2
 
3
- **Mobile Autonomous Developer for Multi-Platform App Development**
4
-
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
-
7
- ## Overview
8
-
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
3
+ 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 through natural language commands.
19
4
 
20
5
  ## Installation
21
-
22
- Install Spirit AI globally via npm:
23
6
  ```bash
24
7
  npm install -g @niyantrilabs/spiritai
25
8
  ```
26
9
 
27
- ## Getting Started
28
-
29
- ### Basic Usage
30
-
31
- Connect to your development server using a connection code:
10
+ ## Usage
32
11
  ```bash
12
+ # Connect to your development server
33
13
  spiritai connect <your-connection-code>
34
- ```
35
-
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
- ```
43
-
44
- ## System Requirements
45
-
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
14
 
50
- ## Platform Support
15
+ # Show help
16
+ spiritai --help
51
17
 
52
- Spirit AI is compatible with the following platforms:
18
+ # Show version
19
+ spiritai --version
20
+ ```
53
21
 
54
- - **macOS**: x64 and ARM64 architectures
55
- - **Linux**: x64 and ARM64 architectures
56
- - **Windows**: x64 and ARM64 architectures
22
+ ## Requirements
57
23
 
58
- ## Development Environment Detection
24
+ - Node.js >= 16.0.0
25
+ - Internet connection for server communication
59
26
 
60
- Spirit AI automatically detects and reports the availability of the following development tools:
27
+ ## Key Features
61
28
 
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
29
+ - Autonomous code generation and modification
30
+ - Surgical precision file operations with line-level editing
31
+ - Real-time bidirectional communication with development servers
32
+ - Intelligent command execution with full system context
33
+ - Comprehensive development environment detection
68
34
 
69
35
  ## Interactive Commands
70
36
 
71
- Once connected to a development server, the following commands are available:
72
-
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
77
-
78
- ## Advanced Features
79
-
80
- ### Surgical Precision Code Editing
81
-
82
- Spirit AI supports advanced code manipulation operations:
83
-
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
37
+ Once connected:
38
+ - `status` - Show connection status
39
+ - `help` - Show available commands
40
+ - `exit` - Exit the agent
41
+ - `clear` - Clear screen
90
42
 
91
- ### File System Operations
43
+ ## Security Notice
92
44
 
93
- The agent provides comprehensive file system access including read, write, create, modify, and delete operations with full directory traversal capabilities.
45
+ Spirit AI operates with full file system access and can execute shell commands. Only connect to trusted servers with verified connection codes.
94
46
 
95
- ## Security Considerations
47
+ ## Learn More
96
48
 
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.
49
+ Visit https://thespiritai.com/ for documentation and examples.
102
50
 
103
51
  ## License
104
52
 
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
53
+ MIT
117
54
 
118
- For bug reports, feature requests, and technical support, please visit:
119
- https://github.com/niyantrilabs/spiritai/issues
55
+ ## Links
120
56
 
121
- ## Version History
57
+ - Website: https://thespiritai.com/
58
+ - GitHub: https://github.com/niyantrilabs/spiritai
59
+ - npm: https://www.npmjs.com/package/@niyantrilabs/spiritai
60
+ - Issues: https://github.com/niyantrilabs/spiritai/issues
122
61
 
123
- Current stable release: 1.0.0
62
+ ---
124
63
 
125
- For detailed version history and release notes, refer to the project's GitHub releases page.
64
+ Developed by Niyantri Labs
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@niyantrilabs/spiritai",
3
- "version": "1.0.2",
3
+ "version": "1.0.4",
4
4
  "description": "Spirit AI - Mobile Autonomous Developer for multi-platform app development",
5
5
  "main": "index.js",
6
6
  "bin": {
7
- "spiritai": "./index.js",
8
- "spirit": "./index.js"
7
+ "spiritai": "index.js",
8
+ "spirit": "index.js"
9
9
  },
10
10
  "scripts": {
11
11
  "start": "node index.js",
@@ -43,7 +43,7 @@
43
43
  },
44
44
  "repository": {
45
45
  "type": "git",
46
- "url": "https://github.com/niyantrilabs/spiritai.git"
46
+ "url": "git+https://github.com/niyantrilabs/spiritai.git"
47
47
  },
48
48
  "bugs": {
49
49
  "url": "https://github.com/niyantrilabs/spiritai/issues"