https://github.com/matdombrock/tuxearch

A Searchable Database of *nix Commands.
https://github.com/matdombrock/tuxearch

Last synced: 7 days ago
JSON representation

A Searchable Database of *nix Commands.

• Host: GitHub
• URL: https://github.com/matdombrock/tuxearch
• Owner: matdombrock
• License: mit
• Created: 2018-04-17T11:55:54.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-17T23:50:26.000Z (about 6 years ago)
• Last Synced: 2024-11-07T04:44:34.059Z (about 2 months ago)
• Language: Python
• Homepage: http://mzero.space/tuxearch/
• Size: 799 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tuxearch

## Pronounced: (tux-search)

### A Searchable Database of *nix Commands. 

[Check It Out!](http://lab.mzero.space:720) [Self-hosted demo site, may be down.]

![Tuxearch Screenshot](https://i.imgur.com/RHU7HqK.gif)

## Adding to the database:

Adding to the database is actually really easy. Just edit "db/database.json" and append the new data to the bottom of the file  as follows:

```

	{

		"INFO" : "info about your command",

		"COMMAND" : "actual command",

		"TAGS" : "tags split by space not commas"

	}

```

Make sure you are adding valid JSON and that you do not break the JSON formatting. If you need yo check your JSON for validity you can use a tool like [JSON Lint](https://jsonlint.com/). 

 

The fastest way to get new data into the system is to submit a pull request on github. However, if you don't feel comforatble with that or don't have the time. Feel free to [sumbit an issue](https://github.com/matdombrock/Tuxearch/issues) and I will work on getting it added in.