diff --git a/README.md b/README.md index b2b6f97..be0ebd9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,46 @@ # gepeto +A CLI tool for creating Pinokio applications. + ## How to use ``` npx gepeto@latest ``` +### CLI Parameters + +You can use gepeto in interactive mode (with prompts) or by providing command-line parameters: + +``` +# Interactive mode +npx gepeto + +# Using command-line parameters +npx gepeto --name= [--git=] [--icon=] [--install=] [--start=] +``` + +#### Parameters + +| Parameter | Description | Default | +|-----------|-------------|---------| +| `--name` | Project name | Interactive prompt (default: "my-app") | +| `--git` | 3rd party git repository URL | Interactive prompt (empty by default) | +| `--icon` | Custom icon URL | Interactive prompt (uses default icon if empty) | +| `--install` | Custom pip install file | Interactive prompt (default: "requirements.txt") | +| `--start` | Custom app start file | Interactive prompt (default: "app.py") | + +#### Examples + +```bash +# Create a project with all parameters specified +npx gepeto --name=my-app --git=https://github.com/user/repo --icon=https://example.com/icon.png --install=requirements.txt --start=main.py + +# Create a project with just a name and custom start file +npx gepeto --name=my-app --start=main.py + +# Create a project from an external git repository +npx gepeto --name=my-app --git=https://github.com/user/repo +``` + Docs: https://gepeto.pinokio.computer diff --git a/index.js b/index.js index 36b05e7..48791cc 100644 --- a/index.js +++ b/index.js @@ -1,4 +1,19 @@ #!/usr/bin/env node +/** + * gepeto - A CLI tool for creating Pinokio applications + * + * Usage: + * npx gepeto - Interactive mode with prompts + * npx gepeto --name= - Project name + * npx gepeto --git= - 3rd party git repository URL + * npx gepeto --icon= - Custom icon URL + * npx gepeto --install= - Custom pip install file (default: requirements.txt) + * npx gepeto --start= - Custom app start file (default: app.py) + * + * Examples: + * npx gepeto --name=my-app --git=https://github.com/user/repo + * npx gepeto --name=my-app --start=main.py --install=requirements.txt + */ // 1. npx gepeto : external git // 2. npx gepeto : no external git const fs = require('fs')