droid-cli 1.1.2 → 1.1.3
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.
- package/README.md +15 -111
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ A powerful, interactive CLI tool for Android development that brings the essenti
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
7
|
- 🔨 **Incremental Builds** - Fast builds using Gradle's build cache
|
|
8
|
-
- 📱 **Device Management** - Easy selection and management of emulators and physical devices
|
|
8
|
+
- 📱 **Device Management** - Easy selection and management of emulators and physical devices
|
|
9
9
|
- 🚀 **Smart Emulator Startup** - Automatically offers to start emulators when no devices connected
|
|
10
10
|
- 📋 **Logcat Integration** - Spawns terminal with filtered app logs
|
|
11
11
|
- ⚙️ **Gradle Tasks** - Run common tasks like clean, sync, and custom tasks
|
|
@@ -51,47 +51,61 @@ droid-cli --project /path/to/android/project [command]
|
|
|
51
51
|
This allows you to run the CLI from anywhere while targeting a specific project.
|
|
52
52
|
|
|
53
53
|
### Interactive Mode
|
|
54
|
+
|
|
54
55
|
```bash
|
|
55
56
|
droid-cli [--project <path>]
|
|
56
57
|
```
|
|
58
|
+
|
|
57
59
|
Launches the main interactive menu with all available options.
|
|
58
60
|
|
|
59
61
|
### Direct Commands
|
|
60
62
|
|
|
61
63
|
#### Build & Run
|
|
64
|
+
|
|
62
65
|
```bash
|
|
63
66
|
droid-cli build [--variant debug|release] [--device device-id] [--project <path>]
|
|
64
67
|
```
|
|
68
|
+
|
|
65
69
|
Builds the app and deploys it to the selected device.
|
|
66
70
|
|
|
67
71
|
#### Device Management
|
|
72
|
+
|
|
68
73
|
```bash
|
|
69
74
|
droid-cli device [--project <path>]
|
|
70
75
|
```
|
|
76
|
+
|
|
71
77
|
List and select target devices/emulators.
|
|
72
78
|
|
|
73
79
|
#### Logcat
|
|
80
|
+
|
|
74
81
|
```bash
|
|
75
82
|
droid-cli logcat [--device device-id] [--project <path>]
|
|
76
83
|
```
|
|
84
|
+
|
|
77
85
|
Opens logcat in a new terminal window, filtered for your app.
|
|
78
86
|
|
|
79
87
|
#### Gradle Tasks
|
|
88
|
+
|
|
80
89
|
```bash
|
|
81
90
|
droid-cli gradle <task> [--args "additional arguments"] [--project <path>]
|
|
82
91
|
```
|
|
92
|
+
|
|
83
93
|
Run any Gradle task with optional arguments.
|
|
84
94
|
|
|
85
95
|
#### Initialize Configuration
|
|
96
|
+
|
|
86
97
|
```bash
|
|
87
98
|
droid-cli init [--project <path>]
|
|
88
99
|
```
|
|
100
|
+
|
|
89
101
|
Set up or reconfigure the CLI for your project.
|
|
90
102
|
|
|
91
103
|
#### Build Variant Selection
|
|
104
|
+
|
|
92
105
|
```bash
|
|
93
106
|
droid-cli variant [--project <path>]
|
|
94
107
|
```
|
|
108
|
+
|
|
95
109
|
Select the default build variant (debug/release) for the project.
|
|
96
110
|
|
|
97
111
|
## Configuration
|
|
@@ -130,37 +144,6 @@ The CLI uses an `droid-cli.json` file in your project root for configuration:
|
|
|
130
144
|
- **`logcat.colorize`** - Enable colored logcat output
|
|
131
145
|
- **`selectedDevice`** - Last selected device (auto-saved)
|
|
132
146
|
|
|
133
|
-
## Supported Terminals
|
|
134
|
-
|
|
135
|
-
The CLI automatically detects and supports:
|
|
136
|
-
|
|
137
|
-
- **macOS**: iTerm2, Terminal.app
|
|
138
|
-
- **Linux**: gnome-terminal, konsole, xterm
|
|
139
|
-
- **Windows**: Windows Terminal
|
|
140
|
-
|
|
141
|
-
## Use Cases
|
|
142
|
-
|
|
143
|
-
### Daily Development Workflow
|
|
144
|
-
|
|
145
|
-
1. **Morning Setup**:
|
|
146
|
-
```bash
|
|
147
|
-
droid-cli device # Select your preferred device
|
|
148
|
-
droid-cli build # Build and deploy
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
2. **Development Loop**:
|
|
152
|
-
```bash
|
|
153
|
-
droid-cli # Interactive menu
|
|
154
|
-
# Select "Build & Run" for quick iterations
|
|
155
|
-
# Select "Open Logcat" when debugging
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
3. **Clean Builds**:
|
|
159
|
-
```bash
|
|
160
|
-
droid-cli gradle clean
|
|
161
|
-
droid-cli build
|
|
162
|
-
```
|
|
163
|
-
|
|
164
147
|
### CI/CD Integration
|
|
165
148
|
|
|
166
149
|
```bash
|
|
@@ -173,75 +156,6 @@ droid-cli gradle assembleRelease
|
|
|
173
156
|
|
|
174
157
|
Share the `droid-cli.json` configuration with your team for consistent build settings.
|
|
175
158
|
|
|
176
|
-
## Comparison with Android Studio
|
|
177
|
-
|
|
178
|
-
| Feature | Android Studio | Droid CLI |
|
|
179
|
-
|---------|---------------|------------------------|
|
|
180
|
-
| Memory Usage | ~2-4 GB RAM | ~50-100 MB RAM |
|
|
181
|
-
| Build Speed | Full IDE overhead | Direct Gradle execution |
|
|
182
|
-
| Logcat | Built-in viewer | Native terminal |
|
|
183
|
-
| Device Management | GUI selection | CLI selection |
|
|
184
|
-
| Project Navigation | Full IDE | Terminal/Editor of choice |
|
|
185
|
-
| Debugging | Full debugger | Logcat + external tools |
|
|
186
|
-
|
|
187
|
-
## Troubleshooting
|
|
188
|
-
|
|
189
|
-
### Common Issues
|
|
190
|
-
|
|
191
|
-
1. **"ADB not found"**
|
|
192
|
-
- Ensure Android SDK is installed
|
|
193
|
-
- Add `adb` to your PATH
|
|
194
|
-
- Verify with: `adb version`
|
|
195
|
-
|
|
196
|
-
2. **"No Android project found"**
|
|
197
|
-
- Run `droid-cli init` in your project directory
|
|
198
|
-
- Ensure `build.gradle` and `settings.gradle` exist
|
|
199
|
-
|
|
200
|
-
3. **Device not detected**
|
|
201
|
-
- Enable USB debugging on your device
|
|
202
|
-
- Check device connection: `adb devices`
|
|
203
|
-
- For emulators, ensure they're running
|
|
204
|
-
|
|
205
|
-
4. **Build failures**
|
|
206
|
-
- Run `droid-cli gradle clean`
|
|
207
|
-
- Check Gradle wrapper permissions: `chmod +x gradlew`
|
|
208
|
-
- Verify Java version compatibility
|
|
209
|
-
|
|
210
|
-
### Debug Mode
|
|
211
|
-
|
|
212
|
-
Set environment variable for verbose logging:
|
|
213
|
-
```bash
|
|
214
|
-
DEBUG=droid-cli droid-cli build
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
## Contributing
|
|
218
|
-
|
|
219
|
-
1. Fork the repository
|
|
220
|
-
2. Create a feature branch
|
|
221
|
-
3. Make your changes
|
|
222
|
-
4. Add tests for new functionality
|
|
223
|
-
5. Submit a pull request
|
|
224
|
-
|
|
225
|
-
## Development
|
|
226
|
-
|
|
227
|
-
```bash
|
|
228
|
-
# Clone the repository
|
|
229
|
-
git clone https://github.com/your-username/droid-cli.git
|
|
230
|
-
cd droid-cli
|
|
231
|
-
|
|
232
|
-
# Install dependencies
|
|
233
|
-
yarn install
|
|
234
|
-
|
|
235
|
-
# Build the project
|
|
236
|
-
yarn build
|
|
237
|
-
|
|
238
|
-
# Run in development mode
|
|
239
|
-
yarn dev
|
|
240
|
-
|
|
241
|
-
# Run tests
|
|
242
|
-
yarn test
|
|
243
|
-
```
|
|
244
|
-
|
|
245
159
|
## License
|
|
246
160
|
|
|
247
161
|
MIT License - see LICENSE file for details.
|
|
@@ -256,13 +170,3 @@ MIT License - see LICENSE file for details.
|
|
|
256
170
|
- [ ] VS Code extension
|
|
257
171
|
- [ ] Windows PowerShell support
|
|
258
172
|
- [ ] Docker container builds
|
|
259
|
-
|
|
260
|
-
## Support
|
|
261
|
-
|
|
262
|
-
- 📖 Documentation: [GitHub Wiki](https://github.com/your-username/droid-cli/wiki)
|
|
263
|
-
- 🐛 Bug Reports: [GitHub Issues](https://github.com/your-username/droid-cli/issues)
|
|
264
|
-
- 💬 Discussions: [GitHub Discussions](https://github.com/your-username/droid-cli/discussions)
|
|
265
|
-
|
|
266
|
-
---
|
|
267
|
-
|
|
268
|
-
**Made with ❤️ for Android developers who love the terminal**
|