{"id":15066557,"url":"https://github.com/chrisallenlane/clinc","last_synced_at":"2025-10-05T03:30:55.290Z","repository":{"id":57200391,"uuid":"72644065","full_name":"chrisallenlane/clinc","owner":"chrisallenlane","description":"A minimalist, scriptable command-line interface for GRBL.","archived":true,"fork":false,"pushed_at":"2017-05-13T23:45:47.000Z","size":32,"stargazers_count":4,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-15T17:35:35.249Z","etag":null,"topics":["cnc","cnc-controller","command-line-tool"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrisallenlane.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-02T13:46:39.000Z","updated_at":"2023-08-17T23:19:49.000Z","dependencies_parsed_at":"2022-09-16T15:00:53.895Z","dependency_job_id":null,"html_url":"https://github.com/chrisallenlane/clinc","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisallenlane%2Fclinc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisallenlane%2Fclinc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisallenlane%2Fclinc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisallenlane%2Fclinc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrisallenlane","download_url":"https://codeload.github.com/chrisallenlane/clinc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235356202,"owners_count":18976819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cnc","cnc-controller","command-line-tool"],"created_at":"2024-09-25T01:09:12.594Z","updated_at":"2025-10-05T03:30:49.994Z","avatar_url":"https://github.com/chrisallenlane.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/chrisallenlane/clinc.svg)](https://travis-ci.org/chrisallenlane/clinc)\n[![npm](https://img.shields.io/npm/v/clinc.svg)]()\n[![npm](https://img.shields.io/npm/dt/clinc.svg)]()\n[![Known Vulnerabilities](https://snyk.io/test/npm/clinc/badge.svg)](https://snyk.io/test/npm/clinc)\n\n\nclinc\n=====\nA minimalist, scriptable command-line interface for GRBL v0.9.\n\n\nInstallation\n------------\nInstall the package directly from npm:\n\n```\n[sudo] npm install -g clinc\n```\n\nThen seed a config file:\n\n```\nclinc config \u003e ~/.clincrc\n```\n\nYou may need to change the default `server.serialPort` path in `~/.clincrc`. To\nsee a list of available serialports, run:\n\n```sh\nclinc-server list\n```\n\nSee [the wiki][conf] for an in-depth guide to configuration.\n\n### Executables ###\nThe`clinc` package will install three executables on your `$PATH`:\n\nExecutable         | Purpose\n-------------------|--------\n`clinc-server`     | Connects to GRBL via the serialport, and displays GRBL output.\n`clinc`            | Provides a user-interface for controlling GRBL via a connection to `clinc-server`.\n`clinc-grbl-debug` | A debugging tool that was used while developing `clinc`. See [the wiki][wiki] for more information.\n\n\nUsage\n-----\nPhysically connect your CNC machine to your computer, then connect to GRBL\nwith:\n\n```sh\nclinc-server -c\n```\n\nNote that `$USER` must have access to the serialport, or `clinc-server` will\nfail with an error. On Debian-based systems, it may be necessary to add `$USER`\nto the `dialout` group. \n\nYou may then use these two commands for sending G-code to `clinc-server`:\n\n- `clinc send (\u003ccommands\u003e | --file=\u003cpath\u003e)`\n- `clinc shell`\n\n### send ###\n`send` can be used to send individual commands to GRBL:\n\n```sh\n# view GRBL configuration\nclinc send '$$'\n```\n\n`send` can also send entire G-code files:\n\n```sh\n#send foo.nc\nclinc send --file=/path/to/foo.nc\n```\n\nShell scripts can streamline the process of running multi-part jobs:\n\n```sh\n#!/bin/sh\n\n# unlock the machine\nclinc send '$X'\n\n# send the first file\nclinc send --file=./step-1.nc\n\n# prompt the user for a tool change\nread -p \"Tool change required. Press 'Enter' when ready\".\n\n# send the second file\nclinc send --file=./step-2.nc\n```\n\n\n### shell ###\n`shell` can be used to control GRBL interactively. Any command entered into the\nshell will be sent directly to GRBL. It is also possible to manually \"jog\" the\nmachine from within the shell.\n\n\n#### Jog Commands ####\nUse the following keypresses to jog the machine:\n\nKeypress             | Action\n---------------------|--------\n`Ctrl + Left Arrow`  | Jog left\n`Ctrl + Right Arrow` | Jog right\n`Ctrl + Up Arrow`    | Jog backward\n`Ctrl + Up Down`     | Jog forward\n`PageUp`             | Raise spindle\n`PageDown`           | Lower spindle\n`\u003cF1\u003e`               | Feed hold\n`Ctrl + l`           | Clear screen\n\nThe `.step` dot-command (see below) can be used to change the machine's step\ndistance.\n\n\n#### \"Dot-commands\" ####\nSeveral \"dot-commands\" extend the shell's functionality:\n\nCommand    | Action\n-----------|------------------------------------------------------------\n`.aliases` | Lists the aliases configured in `~/.clincrc`.\n`.cheat`   | Displays a `clinc` cheatsheet.\n`.exit`    | Exits the shell.\n`.reset`   | Sends a reset instruction (`Ctrl + x`) to GRBL.\n`.send`    | Sends a G-code file to GRBL. (Usage: `.send /path/to/file.nc`).\n`.step`    | Sets the GRBL step distance. (Usage: `.send 0.5`).\n\nNote that `.help` will reveal other available dot-commands (including `.help`\nitself). These are built in to [node's REPL object][repl] (upon which `clinc\nshell` is built). They are of no value to `clinc` users, and should be ignored.\n\n[conf]: https://github.com/chrisallenlane/clinc/wiki/Configuring\n[repl]: https://nodejs.org/api/repl.html\n[wiki]: https://github.com/chrisallenlane/clinc/wiki\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisallenlane%2Fclinc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisallenlane%2Fclinc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisallenlane%2Fclinc/lists"}