visualcodex/setup_simple_install.sh at master · michaeljabbour/visualcodex · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
#!/bin/bash

# Simple setup script for VisualCodex

echo "Setting up VisualCodex for easy installation and startup..."

# Update package.json to ensure npm install and npm start work properly
echo "Updating package.json..."

# Create a simple README with clear instructions
echo "Updating README with simple installation instructions..."

cat > README.md << EOL
# VisualCodex

A modern Electron-based GUI for [open-codex](https://github.com/ymichael/open-codex).

## Features

- Clean, minimal, and modern interface
- Support for all approval modes (Suggest, Auto Edit, Full Auto)
- Visual settings page for API provider configuration
- File browser for project navigation
- Command execution with approval workflow
- Cross-platform support (Windows, macOS, Linux)

## Quick Start

### Prerequisites

- Node.js (v20+)
- npm (v10+)
- open-codex CLI installed and in your PATH

### Installation

1. Clone the repository:
\`\`\`bash
git clone https://github.com/michaeljabbour/visualcodex.git
cd visualcodex
\`\`\`

2. Install dependencies and build:
\`\`\`bash
npm install
\`\`\`

3. Start the application:
\`\`\`bash
npm start
\`\`\`

That's it! The application will automatically build during installation and be ready to use.

## Development

To run in development mode with hot reloading:

\`\`\`bash
npm run dev
\`\`\`

## License

MIT
EOL

echo "Setup completed successfully!"
echo "Users can now simply run 'npm install' and 'npm start' to use the application."