Skip to content

Commit 2fbeb6b

Browse files
authored
Merge pull request #24 from mcpe500/main
feat: Add Termux support (Android) with install script and docs
2 parents cb059e8 + bc50387 commit 2fbeb6b

2 files changed

Lines changed: 623 additions & 0 deletions

File tree

README-termux.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# KolosalCode on Termux
2+
3+
Run KolosalCode on Android using Termux. No root required.
4+
5+
## Requirements
6+
7+
- [Termux](https://termux.dev/en/) app
8+
- Internet connection
9+
- Storage permission (optional, for accessing files outside Termux)
10+
11+
## Installation
12+
13+
1. **Update Termux**
14+
Run this to ensure your package lists and installed tools are up to date:
15+
```bash
16+
pkg update -y && pkg upgrade -y
17+
```
18+
19+
2. **Install Git**
20+
```bash
21+
pkg install git -y
22+
```
23+
24+
3. **Clone the Repository**
25+
```bash
26+
git clone https://github.com/KolosalAI/kolosal-cli.git
27+
cd kolosal-cli
28+
```
29+
30+
4. **Run the Installer**
31+
Use `bash` to run the installer (do not use `sh`):
32+
```bash
33+
bash install-termux.sh
34+
```
35+
36+
This script will:
37+
- Install required dependencies (Node.js LTS, Python, build tools).
38+
- Build the project from source using `esbuild`.
39+
- Install the application to `$PREFIX/opt/kolosal-code`.
40+
- Create a `kolosal` command in `$PREFIX/bin`.
41+
42+
## Usage
43+
44+
Run the CLI:
45+
```bash
46+
kolosal
47+
```
48+
49+
Check version:
50+
```bash
51+
kolosal --version
52+
```
53+
54+
Get help:
55+
```bash
56+
kolosal --help
57+
```
58+
59+
## Troubleshooting
60+
61+
### "Cannot find module 'tiktoken'"
62+
If you see an error about missing modules, ensure you are using the latest `install-termux.sh` which includes a fix to copy external dependencies correctly. Run the installer again:
63+
```bash
64+
bash install-termux.sh
65+
```
66+
67+
### "Permission denied" or "Command not found"
68+
Ensure you are running the script with `bash`:
69+
```bash
70+
bash install-termux.sh
71+
```
72+
### "Permission denied" or "Command not found"
73+
Ensure you are running the script with `bash` as instructed, not `sh` or directly (`./install-termux.sh`).
74+
```bash
75+
bash install-termux.sh
76+
```
77+
78+
### Node.js Warnings
79+
You might see some warnings during `npm install` or execution. These are usually harmless as long as the installation completes and `kolosal --version` works.

0 commit comments

Comments
 (0)