Skip to content

Installation Guide

Jump to bottom
Renz edited this page Sep 8, 2025 · 2 revisions

🚀 Installation Guide

This guide provides detailed instructions for installing the Acode AI CLI Assistant Plugin on your Android device.

📱 Installation Methods

There are three ways to install the plugin:

Method 1: From Acode Plugin Store (Recommended)

This is the easiest and most straightforward method:

  1. Open the Acode app on your Android device
  2. Navigate to Settings → Plugins
  3. Search for "Renz" in the plugin store
  4. Tap Install to download and install the plugin
  5. Tap Enable to activate the plugin
  6. Restart Acode to complete the installation

Method 2: Manual Installation from ZIP

If you prefer to install from a local file:

  1. Download the latest acode-ai-cli.zip from the Releases page
  2. Open Acode app
  3. Go to Settings → Plugins
  4. Tap Install from ZIP/Local
  5. Browse and select the downloaded ZIP file
  6. Enable the plugin after installation
  7. Restart Acode app to complete the installation

Method 3: Development Build Installation

For developers who want to build from source:

  1. Clone the repository:

    git clone https://github.com/RenzMc/Acode-Plugin-AI-cli.git
cd Acode-Plugin-AI-cli

  2. Install dependencies:

    npm install

  3. Build the plugin:

    npm run build

  4. The built plugin will be available in the dist directory

  5. Package the contents of the dist directory into a ZIP file

  6. Follow the manual installation steps (Method 2) using your custom ZIP file

⚙️ System Requirements

Acode Version

  • Minimum required version: Acode 1.8.0 or higher
  • Recommended version: Latest stable release of Acode

Device Specifications

  • RAM: Minimum 2GB, recommended 4GB or more
  • Storage: At least 50MB free space
  • Internet Connection: Required for AI provider connectivity

🔧 Post-Installation Steps

After installing the plugin, you should:

  1. Restart Acode: This ensures all plugin components are properly loaded
  2. Check Plugin Status: Go to Settings → Plugins and verify the AI CLI Assistant is enabled
  3. Configure API Keys: Set up your preferred AI provider credentials
  4. Test Functionality: Open the AI assistant and try a simple query to verify everything works

🔄 Updating the Plugin

From Plugin Store

If you installed from the Acode Plugin Store, updates will be available automatically:

  1. Go to Settings → Plugins
  2. Look for update notifications for AI CLI Assistant
  3. Tap Update to install the latest version

Manual Updates

If you installed manually:

  1. Download the latest release ZIP file
  2. Go to Settings → Plugins
  3. Find AI CLI Assistant in the installed plugins list
  4. Tap the three dots menu → Update
  5. Select the new ZIP file

❌ Uninstalling the Plugin

To uninstall the plugin:

  1. Open Acode app
  2. Go to Settings → Plugins
  3. Find AI CLI Assistant in the installed plugins list
  4. Tap the three dots menu → Uninstall
  5. Confirm the uninstallation when prompted

Note: Uninstalling the plugin will remove all associated files but will preserve your API keys in the Acode storage.

📋 Troubleshooting Installation Issues

Common Installation Problems

Plugin Not Appearing in Store

  • Ensure you have the latest version of Acode
  • Check your internet connection
  • Try clearing the Acode cache and restarting

Installation Fails with Error

  • Verify you have sufficient storage space
  • Check that the ZIP file is not corrupted
  • Ensure you're using a compatible version of Acode

Plugin Installed but Not Working

  • Restart Acode completely
  • Check that the plugin is enabled in Settings → Plugins
  • Verify your API keys are properly configured

Installation Verification

To verify the plugin is correctly installed:

  1. Open Acode
  2. Look for the AI CLI Assistant icon in the sidebar
  3. Try opening the assistant using the keyboard shortcut Ctrl/Cmd + Shift + A
  4. Check that all keyboard shortcuts are working

💡 Tips for Successful Installation

  1. Always restart Acode after installing or updating plugins
  2. Use the latest stable version of Acode for best compatibility
  3. Ensure sufficient storage space before installation
  4. Check internet connectivity if installing from the plugin store
  5. Backup your projects before installing new plugins (just as a precaution)

📞 Getting Help

If you encounter issues during installation:

  1. Check the Common Issues documentation
  2. Visit our GitHub Issues page
  3. Join our Discussions community for support

Clone this wiki locally