Introduction ℹ️⌗

Want to learn command syntax, hierarchy structure and command configs? Don’t want to read long man pages like git has?

Then this project is for you! Don’t just copy-paste things, learn them through provided examples! Just look how our page is simpler:

Note for programmers: all pages are written in a parsable way, so it’s possible automatically extract some data from them to handle it.

Installation 😄⌗

Via the following commands you can install our page render:

bash Installation commands


temp="$(mktemp)"
wget -O "$temp" https://raw.githubusercontent.com/command-line-interface-pages/v2-tooling/main/clip-view/makefile
make -f "$temp" remote-install

To verify whether if successfully installed to /home/$USER/.local/bin type clip-view --version. To view cat page just type clip-view cat.

Note for programmers: installation also can be done via cloning tools repo, moving to clip-view directory and issuing make install command.

Uninstallation 😞⌗

All tools are being installed in /home/$USER/.local/bin directory. So to remove them just run rm command like rm /home/$USER/.local/bin/clip-view.

Note for programmers: uninstallation also can be done via moving to clip-view directory and issuing make uninstall command.

Why to use this project? ❓⌗

Write less, gain more
Permit users to use their preferences
Write in the parsable format
Customize page look as you want
Add page for any project you want

ℹ️ Note: projects with less than 5 stars considered as untrusted. It doesn’t characterize them negatively, it just means they are not popular now.

Expectations from the end user 📚⌗

We assume that the end user is already familiar with some programming stuff. To be more precise we expect all page syntax to be understandable by default no matter it what. When we encounter some repetitive problem we standardize a way to solve it. We don’t handle each page specifically.

Contributions 🛠️⌗

Each repository contains link to it’s contributing guide (named CONTRIBUTING.md) where you can learn how to get started with writing your own pages, themes or tools.

Basically, to write themes you should know YAML while for writing pages Markdown is required. If you wanna more than it’s possible to develop project tools like render, parser and other stuff which are written mainly in Bash.

Supported by 😍⌗

Cheat (partial 🔴)Cheatsheets (full 🟢)Eg (partial 🔴)TlDr (full 🟢)

🔴 Partial support: just FAQ for this project is provided.
🟢 Full support: this project is also mentioned in README.md.

About

Contents