cli/README.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

2024-09-22 20:48:05 +02:00
## About
2024-09-22 22:20:18 +02:00
webskel is a command-line utility that provides skeletons (or "templates")
to help you quickly start your next web application or service. The concept
is inspired by skeleton directories from the UNIX world, where they can serve
2024-09-23 00:18:19 +02:00
as the starting point for a new user's `${HOME}` directory. The utility is
written in POSIX shell to maximize portability and minimize runtime
2024-09-23 00:19:16 +02:00
dependencies.
2024-09-22 20:48:05 +02:00
## Examples
2024-09-22 20:50:11 +02:00
### CLI
2024-09-22 20:48:05 +02:00
2024-09-23 00:21:43 +02:00
* **webskel new** <br>
2024-09-22 20:50:11 +02:00
The `webskel new` command creates a new application from a specified skeleton.
2024-09-22 22:45:09 +02:00
For example, the following command will create a "myapp" directory from the
`dolphins7` skeleton:
2024-09-22 20:48:05 +02:00
2024-09-23 00:21:43 +02:00
user@localhost$ webskel new myapp dolphins7
2024-09-22 20:48:05 +02:00
2024-09-23 00:21:43 +02:00
* **webskel ls** <br>
2024-09-22 22:45:09 +02:00
The `webskel ls` command lists all available skeletons by name, and includes a
short description as well. These skeletons are located in the [share/webskel/](share/webskel)
directory, which is typically installed relative to `/usr/local`:
2024-09-22 20:50:11 +02:00
2024-09-23 00:21:43 +02:00
user@localhost webskel ls
2024-09-22 20:50:11 +02:00
## Sources
* [GitHub](https://github.com/webskel/cli#readme)
2024-09-22 23:04:59 +02:00
* [GitLab](https://gitlab.com/webskel/cli#about)
* [brew.bsd.cafe/@webskel](https://brew.bsd.cafe/webskel/cli#about)
2024-09-22 20:48:05 +02:00
## License
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/) <br>
See [LICENSE](./LICENSE)