-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e1ff158
commit c2993aa
Showing
1 changed file
with
33 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,33 @@ | ||
### Synix: A no flag nodeJS CLI | ||
## [Synix](https://synixjs.github.io/): A no-flag nodeJs CLI to make the use of command-line easy and uniform | ||
|
||
### Getting started | ||
```bash | ||
|
||
# installation | ||
$ npm i -g synix | ||
|
||
# initialisation | ||
$ sx init code # for vscode | ||
|
||
# checking version | ||
$ sx versiuon # or sx v | ||
|
||
``` | ||
### Basic usage | ||
```bash | ||
|
||
$ sx ls | ||
# lists the folders and files in the cwd | ||
|
||
$ sx mkdir <folder-name> | ||
# creates that folder in your cwd | ||
|
||
``` | ||
|
||
#### A complete guide of all the commands is written [here](https://synix-docs.netlify.com/ccc/commands.html) | ||
--- | ||
|
||
> Star the repository if you like it, and I hope this speeds up your development | ||
### Contributors | ||
If you want to contribute to this then create an issue and then we'll assign you. A more detailed way is present [here](https://synix-docs.netlify.com/ccc/contribute.html) |