File tree Expand file tree Collapse file tree 1 file changed +36
-26
lines changed
Expand file tree Collapse file tree 1 file changed +36
-26
lines changed Original file line number Diff line number Diff line change 11# 🌶️ SpiceCode CLI - Making your code spicier 🔥🥵
22
3+ ## Installing via PIP
34
4- ### Installing via PIP
55- Make sure you have Python installed on your system
66- Open the terminal
77- Install SpiceCode via PIP with:
8- ```
8+
9+ ``` bash
910pip install spicecode
1011```
1112
1213### Using SpiceCode
14+
1315- After installing via PIP, you can run these three commands: * (replace file with the filename)*
1416
15- ```
17+ ``` bash
1618spice hello
1719```
1820
19- ```
21+ ``` bash
2022spice translate
2123```
2224
23- ```
25+ ``` bash
2426spice analyze FILE
2527```
2628
27- - EXAMPLE:
28- ```
29+ - EXAMPLE:
30+
31+ ``` bash
2932spice analyze code.js
3033```
3134
32-
3335---
3436
35- ### Supported Programming Langagues for Analysis:
37+ ### Supported Programming Langagues for Analysis
38+
3639[ ![ My Skills] ( https://skillicons.dev/icons?i=python,js,ruby,go&perline=10 )] ( https://skillicons.dev )
3740
3841- Python ** (.py)**
3942- JavaScript ** (.js)**
4043- Ruby ** (.rb)**
4144- Go ** (.go)**
42- - Many more ** coming soon!**
4345
44-
45- #### All lexers and parsers are built by us. We don't use external libraries/packages to parse your code.
46-
47-
46+ #### All lexers and parsers are built by us. We don't use external libraries/packages to parse your code
4847
4948---
5049
51- You can ** visit our page on the pypi registry** : https://pypi.org/project/spicecode/
50+ You can ** visit our page on the pypi registry** : [ https://pypi.org/project/spicecode/ ] ( https://pypi.org/project/spicecode/ )
5251
5352---
5453
55-
5654### For Development
55+
5756- Clone the repo to your machine
5857- Go to the cloned spicecode folder
5958- Create a python virtual environment (venv):
60- ```
59+
60+ ``` bash
6161python -m venv venv
6262```
6363
6464- Activate your virtual environment:
65+
6566- ** Windows**
66- ```
67+
68+ ``` bash
6769./venv/Scripts/activate
6870```
71+
6972- ** Linux**
70- ```
73+
74+ ``` bash
7175source ./venv/bin/activate
7276```
7377
7478- Install all packages from requirements.txt:
75- ```
79+
80+ ``` bash
7681pip install -r requirements.txt
7782```
7883
7984- Install (build) the spicecode package locally:
80- ```
85+
86+ ``` bash
8187pip install -e .
8288```
8389
8490- Have fun!
85- ```
91+
92+ ``` bash
8693spice version
8794```
88- ```
95+
96+ ``` bash
8997spice hello
9098```
91- ```
99+
100+ ``` bash
92101spice translate
93102```
94- ```
103+
104+ ``` bash
95105spice analyze
96- ```
106+ ```
You can’t perform that action at this time.
0 commit comments