Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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=<name> [--git=<url>] [--icon=<url>] [--install=<file>] [--start=<file>]
```

#### 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
15 changes: 15 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -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=<name> - Project name
* npx gepeto --git=<url> - 3rd party git repository URL
* npx gepeto --icon=<url> - Custom icon URL
* npx gepeto --install=<file> - Custom pip install file (default: requirements.txt)
* npx gepeto --start=<file> - 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 <name> <git url>: external git
// 2. npx gepeto <name>: no external git
const fs = require('fs')
Expand Down