@niyantrilabs/spiritai 1.0.3 → 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 -88
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,118 +1,64 @@
1
1
  # Spirit AI
2
2
 
3
- **Autonomous Developer for Multi-Platform Development**
4
-
5
- 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.
6
-
7
- ## Overview
8
-
9
- 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.
10
-
11
- ## Key Capabilities
12
-
13
- - Autonomous code generation and modification across your entire project
14
- - Surgical precision file operations with line-level editing accuracy
15
- - Real-time bidirectional communication with development servers
16
- - Intelligent command execution with full system context awareness
17
- - Advanced code editing operations including targeted modifications
18
- - Comprehensive development environment detection and integration
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
14
 
46
- - Node.js version 16.0.0 or higher
47
- - Active internet connection for server communication
48
- - Compatible operating system (Windows, macOS, or Linux)
15
+ # Show help
16
+ spiritai --help
49
17
 
50
- ## Platform Support
18
+ # Show version
19
+ spiritai --version
20
+ ```
51
21
 
52
- Spirit AI is compatible with the following platforms:
22
+ ## Requirements
53
23
 
54
- - **macOS**: x64 and ARM64 architectures
55
- - **Linux**: x64 and ARM64 architectures
56
- - **Windows**: x64 and ARM64 architectures
24
+ - Node.js >= 16.0.0
25
+ - Internet connection for server communication
57
26
 
58
- ## Development Environment Detection
27
+ ## Key Features
59
28
 
60
- 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.
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
61
34
 
62
35
  ## Interactive Commands
63
36
 
64
- Once connected to a development server, the following commands are available:
65
-
66
- - `status` - Display current connection status and system information
67
- - `help` - Show available commands and usage instructions
68
- - `exit` or `quit` - Terminate the agent session
69
- - `clear` - Clear the terminal screen
70
-
71
- ## Advanced Features
72
-
73
- ### Surgical Precision Code Editing
74
-
75
- Spirit AI supports advanced code manipulation operations:
76
-
77
- - **DELETE_LINE** - Remove specific lines from source files
78
- - **REPLACE_LINE** - Replace content at specific line numbers
79
- - **INSERT_BEFORE** - Insert new lines before specified positions
80
- - **INSERT_AFTER** - Insert new lines after specified positions
81
- - **REMOVE_IMPORT** - Remove unused import statements
82
- - **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
83
42
 
84
- ### File System Operations
43
+ ## Security Notice
85
44
 
86
- 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.
87
46
 
88
- ## Security Considerations
47
+ ## Learn More
89
48
 
90
- **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.
91
-
92
- ## Technical Architecture
93
-
94
- 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.
95
50
 
96
51
  ## License
97
52
 
98
- This project is licensed under the MIT License. See the LICENSE file for complete terms and conditions.
99
-
100
- ## Maintainer
101
-
102
- Developed and maintained by Niyantri Labs.
103
-
104
- ## Source Code
105
-
106
- The complete source code is available on GitHub:
107
- https://github.com/niyantrilabs/spiritai
108
-
109
- ## Support and Issues
53
+ MIT
110
54
 
111
- For bug reports, feature requests, and technical support, please visit:
112
- https://github.com/niyantrilabs/spiritai/issues
55
+ ## Links
113
56
 
114
- ## 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
115
61
 
116
- Current stable release: 1.0.2
62
+ ---
117
63
 
118
- 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,6 +1,6 @@
1
1
  {
2
2
  "name": "@niyantrilabs/spiritai",
3
- "version": "1.0.3",
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": {