https://github.com/konstantine-v/crfetch
NeoFetch written in Crystal - WIP
https://github.com/konstantine-v/crfetch
cli crystal crystal-lang crystal-language fetch
Last synced: 8 months ago
JSON representation
NeoFetch written in Crystal - WIP
- Host: GitHub
- URL: https://github.com/konstantine-v/crfetch
- Owner: konstantine-v
- License: mit
- Created: 2020-02-17T03:42:10.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-22T17:50:51.000Z (about 6 years ago)
- Last Synced: 2024-10-25T01:25:55.393Z (over 1 year ago)
- Topics: cli, crystal, crystal-lang, crystal-language, fetch
- Language: Crystal
- Homepage:
- Size: 17.6 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CrFetch
A simple fetch program to print your system details for that sweet /g/ street cred
The idea is for it to work much like NeoFetch
## Installation
``` sh
$ shards && cake # => ./bin/crfetch
```
## Usage
After making with cake run the binary
``` sh
$ ./bin/crfetch
```
You can create an alias for this so it's easier to access
The idea is that it'll work like this to specify what you want to output
``` sh
$ crfetch -c -i -cc
```
## Development
Follow install instructions.
Make sure to run tests:
``` sh
$ crystal spec
```
All tests should pass before developing. If tests do not pass make sure to look
at the log and figure out why, if it's a bug or a feature that you're wanting then
make an issue and if you want to then make a pull request for it.
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Konstantine](https://github.com/materialfuture) - creator and maintainer
## Notes
Look into turning the lookup for system info into a Library after completing the
basic version
## Todo
### Needs
- [ ] Get Operating System/Distro for all main machine types
- [ ] Get CPU Specs including number of cores (logical and physical)
- [ ] Get Memory; Total, Taken, Available
- [ ] Get GPU, Brand, VRAM, etc.
- [ ] Get HDD/SSD info,
### Extras
- [ ] Get Shell used (fish, zsh, bash, etc)
- [ ] Get Packages installed via whatever package manager
- [ ] CPU temperatures, speed, etc.
### QOL
- [x] Add Shell shard to make shell commands easier to execute
- [ ] Integrate Admiral Shard to have flags and arguments
- [ ] Integrate the tablo (or other) Shard to cleanup output
- [ ] Break out MacOS commands via grep or awk