# @ajnandi/syntax

> Solve your problems

Latest version **0.1.4** (published 2020-03-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ajnandi/syntax
pnpm add @ajnandi/syntax
yarn add @ajnandi/syntax
bun add @ajnandi/syntax
```

Provides the command `syntax`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2020-03-13 |
| First published | 2020-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 107.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | AJNandi |
| Maintainers | ajnandi |

## Links

- npm: https://www.npmjs.com/package/@ajnandi/syntax
- Repository: https://github.com/AJNandi/Syntax
- npm.io page: https://npm.io/package/@ajnandi/syntax

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [graphql](https://npm.io/package/graphql.md) ^14.5.8
- [nodemon](https://npm.io/package/nodemon.md) ^2.0.2
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.4
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0
- [node-netrc](https://npm.io/package/node-netrc.md) ^0.1.0
- [graphql-tag](https://npm.io/package/graphql-tag.md) ^2.10.1
- [apollo-boost](https://npm.io/package/apollo-boost.md) ^0.4.7

## Recent versions

- 0.1.4 (latest) — 2020-03-13
- 0.1.3 — 2020-03-13
- 0.1.2 — 2020-03-13
- 0.1.1 — 2020-03-12

## README

# 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](mailto: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](http://syntaxsearch.io) to see what's tracked.**

---
_Source: https://npm.io/package/@ajnandi/syntax · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._