https://github.com/phel-lang/cli-skeleton
A simple skeleton to build your cli-app using Phel.
https://github.com/phel-lang/cli-skeleton
cli-scaffolding functional-programming phel phel-lang php
Last synced: about 2 months ago
JSON representation
A simple skeleton to build your cli-app using Phel.
- Host: GitHub
- URL: https://github.com/phel-lang/cli-skeleton
- Owner: phel-lang
- License: mit
- Created: 2023-04-01T10:52:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-09T17:29:21.000Z (4 months ago)
- Last Synced: 2025-08-25T10:31:25.419Z (about 2 months ago)
- Topics: cli-scaffolding, functional-programming, phel, phel-lang, php
- Language: PHP
- Homepage: https://phel-lang.org/
- Size: 31.3 KB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Phel Cli Skeleton
[Phel](https://phel-lang.org/) is a functional programming language that compiles to PHP.
This repository provides you the basic setup to start coding phel.
## Getting started
### Requirements
Phel requires at least PHP 8.2 and Composer.
You can either use it from your local machine OR using docker.
- This repository contains the basic Dockerfile to run phel.
#### Locally (no Docker)
1. Ensure you have PHP >=8.2 (Some help about how to install multiple PHP versions locally on [linux](https://github.com/phpbrew/phpbrew) and [Mac](https://github.com/shivammathur/homebrew-php))
1. Ensure you have [composer](https://getcomposer.org/composer-stable.phar)
1. Clone this repo
1. Install the dependencies | `composer install`
#### Using Docker
1. Clone this repo
1. Build the image | `docker-compose up -d --build`
1. Go inside the console | `docker exec -ti -u dev phel_cli_skeleton bash`
1. Install the dependencies | `composer install`
### Phel code
1. Write your phel code in `src/`
1. Run your code with `vendor/bin/phel run src/main.phel`
#### Or run the executable transpiled PHP result
1. `vendor/bin/phel build`
1. `php out/main.php`
#### Tests
1. Write your phel tests in `tests/`
1. Execute your tests with `./vendor/bin/phel test`
## More about starting with phel
Find more information about how to start with phel in [getting started](https://phel-lang.org/documentation/getting-started/).