Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mustansirzia/mustansir.npx

My name "mustansir" as an npx command. 🚀
https://github.com/mustansirzia/mustansir.npx

challenge cli command mustansir npm npx portfolio terminal typescript

Last synced: 7 days ago
JSON representation

My name "mustansir" as an npx command. 🚀

Awesome Lists containing this project

README

        

# mustansir.npx

[![npm version](https://badge.fury.io/js/mustansir.svg)](https://badge.fury.io/js/mustansir)
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)

> My name "mustansir" as an npx command 🚀.





# Demo.




# Why?

I created this command as sort of my portfolio that can be accessed from any terminal with Node.js. I was very curious to see if such a thing could be accomplished and it turned out to be quite easy at the end.




# Run.

Assuming you have Node.js installed, to run this command, simply do.

```sh
npx mustansir
```




# Bonus.

You can use this repository to make your name as an npx command! To do this following the instructions:

- Clone this repository. `git clone https://github.com/MustansirZia/mustansir.npx.git`.
- Open `src/config.json` and change the variables for name, bio, github username, etc. to your own. There's a bunch of other stuff you can change there as well.
- Open `package.json` and change `name` field to whatever you wish the command to be.
- Inside the same file, change `version` field to `1.0.0`.
- Login into your npm account using the cli `npm login`. (You might want to create an npm account if you don't have one)
- Publish your npx command using `npm publish`.
- Make everyone else think you're cool by telling them to type `npx ` where `

![Cool GIF](https://media.giphy.com/media/62PP2yEIAZF6g/giphy.gif)




# License.

MIT.