https://github.com/cli-guidelines/cli-guidelines

A guide to help you write better command-line programs, taking traditional UNIX principles and updating them for the modern day.
https://github.com/cli-guidelines/cli-guidelines

Last synced: 3 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/cli-guidelines/cli-guidelines
• Owner: cli-guidelines
• License: cc-by-sa-4.0
• Created: 2020-04-25T02:51:46.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-30T18:39:55.000Z (20 days ago)
• Last Synced: 2025-01-09T03:25:01.297Z (10 days ago)
• Language: CSS
• Homepage: https://clig.dev
• Size: 114 MB
• Stars: 3,010
• Watchers: 31
• Forks: 103
• Open Issues: 61
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome - cli-guidelines/cli-guidelines - 12 star:3.0k fork:0.1k A guide to help you write better command-line programs, taking traditional UNIX principles and updating them for the modern day. (CSS)
• awesome-starts - cli-guidelines/cli-guidelines - A guide to help you write better command-line programs, taking traditional UNIX principles and updating them for the modern day. (CSS)
• awesome-list - cli-guidelines - line programs, taking traditional UNIX principles and updating them for the modern day. | cli-guidelines | 1403 | (CSS)

README

        
# 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](https://clig.dev/).

[Join us on Discord](https://discord.gg/EbAW5rUCkE) 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](content/_index.md).

The website is built using [Hugo](https://gohugo.io/).

To run Hugo locally to see your changes, run:

```

$ brew install hugo

$ cd //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](http://creativecommons.org/licenses/by-sa/4.0/).