uhelp(pip package) Your own Linux command help dictionary
Project description
uhelp
You can also search for an excellent community base cheat sheet tldr
and you can also set it to be displayed at the same time as your own.
NOTE : Now Making
I don't have an x86_64 computer at hand, so I can't check the operation of the package,
so I would appreciate it if you could report that it doesn't work..
Install
Ways 1
using pipnormaly. from pypi
pip install uhelp
Package and install directly from this repository with pip
pip install git+https://github.com/Suletta-Majo/uhelp.git
You may get an error because this repository have a lot of fine tldr dictionary files,
you may need the following config set extend Git buffer
git config --global http.postBuffer 524288000
Ways 2
deb packageDownload the latest release at the bottom that matches your computer's CPU architecture
Cannot be installed on Termux! if proot-distro environment is possible
It is a deb package that uses the compiled Python source.
Please Make the X.X.X_***** part the same as the downloaded filename
or specify it with a wildcard like uhelp*.deb
apt install ./uhelp_X.X.X_*****.deb
*Do not install the PIP version and the DEB version together.*
conflict
Both are a method of starting the program by creating a symbolic link with the same name(uh) in usr/bin.
So it is possible that one will not start.
Usage
If you install with pip, you can call it with uh
,
and if you install deb with apt, you can call it with uh
or uhelp
.
show your command reference example below in case ls
uh ls
uhelp ls
priority is User Dictionary > Built-in Dictionary
Edit your own help item
uh -e [command name]
The text editor opens and you can edit it with reference to the description.
*About Tags Available for Editing*
it's possible to specify the basically textual/rich console markup tag syntax,
like [blue][/blue] or [#ffffff on blue][/]
The tags that are likely to be used in uhelp are defined in the rich_theme_manager directory included with the program.
[codez], [warning] .etc
Remove your own help item
uh -r [command name]
Change Theme
uh -v [theme name]
Now you can choose from 5 options: default, retro, retro2, simple, fruits
default | cyber |
---|---|
retro | retro2 |
---|---|
simple | fruits |
---|---|
Tldr viwer Mode
uh -t [command name]
Command help mode using only tldr pages
Check out the uhelp dictionary for other options such as backups and restores.uh uhelp
As a bonus feature, there is a function to take a short note before falling asleep
uh -s i try fix suboutput function.but I think I'm going to sleep
uh -s "i try fix suboutput function.but I think I'm going to sleep"
Record up to 10 records
To view choose on prompt 'no'
Author
👤 Suletta-Majo
- Github: @Suletta-Majo
Show your support
Give a ⭐️ if this project helped you!
appendix: A very useful tools used to create this page!!
This README was generated with ❤️ by readme-md-generator
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file uhelp-0.6.3.tar.gz
.
File metadata
- Download URL: uhelp-0.6.3.tar.gz
- Upload date:
- Size: 1.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e5cbde59d9fdc9c299686f5e2817ecd230c22e905dc450e86517eb75fda7be7 |
|
MD5 | 5f0d837b2d5ab51735cbcafad2048e86 |
|
BLAKE2b-256 | 55c7d7121c08ab6706400df1cd75a17de1406aedb15e90a45a79379216337994 |
File details
Details for the file uhelp-0.6.3-py3-none-any.whl
.
File metadata
- Download URL: uhelp-0.6.3-py3-none-any.whl
- Upload date:
- Size: 2.0 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14ca51f0430131d48610cfe88988cf56b692d3d58c7e6ca32e379bf6eaa81e98 |
|
MD5 | e4a08fe8cf349ab2a849825836793ab8 |
|
BLAKE2b-256 | 195399218acbcbb045b49a7554219ee8bb1c4126435c71382ac6d0c168d37327 |