Usage Guide
Gossip is written in
.gos
files, which is the officially supported extension for Gossip. To run the intrerpreter with an input file containing Gossip code, use the -f or –from-file option followed by the path to the input file:python main.py -f ./path/to/input.gos
For example, to run the
test.gos
file, use the following command:python main.py -f ./examples/test.gos
python main.py --from-file ./examples/test.gos
.. caution:: Make sure to use a distribution with
dataclass
support in python. In our experience, version3.10.0
works best, and is the officially supported distribution.To update Gossip to the latest version, use the -u or –update option:
python main.py -u
python main.py --update
To start an interactive prompt where you can enter Gossip code directly, use the -i or –interpret option:
python main.py -i
python main.py --interpret
To show feedback whenever a command is entered, use the -s or –show-feedback option:
python main.py -s
python main.py --show-feedback
To show a visualization of the Gossip code, line by line, use the -v or –visualize option:
python main.py -v
python main.py --visualize
.. admonition:: Note We recommend using this along with the –interpret flag so your screen is not overwhelmed with AST visualizations. ..
Once you have finished using Gossip, you can exit the program by pressing CTRL-C
or typing exit
at the prompt. You can also clear
to clean up the screen.
In addition, you can use these expressions in tandem. For example, an interesting operation might be to both interpret and visualize at the same time.
python main.py --interpret --visualize
Head on over to the syntax page to learn more about the Gossip syntax.