# Contribute
Make a new issue to contribute and we will look into it and will assign you
Always send your pull request targeting the default branch unless specified
Organisation : https://github.com/synixjs
Github : https://github.com/synixjs/synix
Documentation Repository : https://github.com/synixjs/synix-docs
# File structure
.
├── commands
│ ├── cat.js
│ ├── cp.js
│ ├── edit.js
│ ├── exportFile.js
│ ├── help.js
│ ├── init
│ │ ├── atom.json
│ │ ├── code.json
│ │ ├── init.js
│ │ └── subl.json
│ ├── ls.js
│ ├── misc
│ │ ├── clone.js
│ │ └── sync.js
│ ├── mkdir.js
│ ├── mkpro.js
│ ├── mv.js
│ ├── open.js
│ ├── pwd.js
│ ├── rm.js
│ ├── sxcustom.js
│ ├── sxglobal.js
│ ├── touch.js
│ └── version.js
├── LICENSE
├── package.json
├── package-lock.json
├── README.md
├── sxconfig.json
└── sx.js
- Every command is present as a
.jsfile with the same name as the command - The
sx.jsis the main file that runs globally - The
initcommand has it's own directory calledinitwhich has the json files of the text-editor configs - The
sxconfig.jsonis the base config file of the synix-cli - The
miscfolder contains all the miscellaneous commands - The
exportFile.jsis used to collect the commands from the directory and export them which will be then imported in thesx.js
# Local build
There is a develop branch of synix (the default branch) which is used to test the commands before implementing it in the master branch
$ npm link
# in the root
# will link synix-develop globally
# this gives sxd command not sx
$ npm unlink
# in thr root
# will remove it globally
Once you get the sxd command everything else is same.
Linux users please don't allow
sudoto run without password