Syntax Documentation

Docs are in progress

Getting Started

Create a Syntax Account

Create a directory

    mkdir syntax-demo
    cd syntax-demo

Init package manager

    # Using NPM
    npm init
    
    # Using Yarn
    yarn init

Download the Syntax node module from NPM

    # Using NPM
    npm install @ajnandi/syntax -g
    
    # Using Yarn
    yarn global add @ajnandi/syntax 

Log into Syntax CLI

Run the following command and enter your Syntax email and password when prompted

This will allow you to run Syntax commands from inside your terminal

    $ syntax login
    ? Login to Syntax. Email: [email@emailaddress.com]
    ? Password: [hidden]

Create your first thread

Navigate to the folder you would like to start tracking inside Syntax.

Once there, enter the following command and once prompted, name the thread.

    $ syntax thread
    ? Name this thread: [thread name]

Great, now you're ready to start using Syntax inside your existing workflow.

Using Syntax To Track Solutions

Currently we only support node based javascript programs. If you would like to see us add support to something else, send us a note at hello@syntaxsearch.io

Running your node program

Once there, enter the following command and once prompted, name the thread.

    $ syntax run [file.js]
    . [console.log output]
    .
    .
    ? Name this diff: [diff name]

Errors and Solutions

Syntax catches errors. If your program crashes, continue debugging as you normally would.

Each change you make to the codebase and each run of the program is catalogued.

If your next run does solve the original error, then your error and solution are catalogued online together for everyone to learn from!

Visit syntaxsearch.io to see what's tracked.