gimenete / cli-guidelines

A guide to help you write better command-line programs, taking traditional UNIX principles and updating them for the modern day.

Home Page:https://clig.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Command Line Interface Guidelines

An open-source guide to help you write better command-line programs, taking traditional UNIX principles and updating them for the modern day.

This is the source code for the guide. To read it, go to clig.dev.

Join us on Discord if you want to discuss the guide, or just chat about CLI design.

Contributing

The content of the guide lives in a single Markdown file, content/_index.md. The website is built using Hugo.

To run Hugo locally to see your changes, run:

$ brew install hugo
$ cd <path>/<to>/cli-guidelines/
$ hugo server

To view the site on an external mobile device, run:

hugo server --bind 0.0.0.0 --baseURL http://$(hostname -f):1313

License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

About

A guide to help you write better command-line programs, taking traditional UNIX principles and updating them for the modern day.

https://clig.dev

License:Creative Commons Attribution Share Alike 4.0 International


Languages

Language:CSS 68.5%Language:JavaScript 19.4%Language:HTML 12.1%