https://github.com/contiguity/cli
Contiguity's official CLI.
https://github.com/contiguity/cli
cli documentation
Last synced: 8 months ago
JSON representation
Contiguity's official CLI.
- Host: GitHub
- URL: https://github.com/contiguity/cli
- Owner: contiguity
- License: mit
- Created: 2023-06-15T16:16:22.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-21T08:44:14.000Z (over 2 years ago)
- Last Synced: 2025-03-07T01:47:33.388Z (over 1 year ago)
- Topics: cli, documentation
- Language: TypeScript
- Homepage: https://cli.contiguity.co
- Size: 98.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Contiguity CLI
Contiguity CLI provides a command-line interface to interact with Contiguity’s API.
Read more about using the CLI in the docs, at
[docs.contiguity.co](https://docs.contiguity.co/#/cli/).
## Installation
Contiguity CLI can be used with [Node.js](https://nodejs.org) or [Deno](https://deno.com/).
Install the Contiguity CLI with Node:
```bash
$ npm install -g @contiguity/cli
```
Alternatively, install the Contiguity CLI with Deno:
```bash
$ deno install -An contiguity jsr:@contiguity/cli
```
You can also run the CLI without installing it with either Node or Deno:
```bash
$ npx @contiguity/cli --help
$ deno run -A jsr:@contiguity/cli --help
```
## Setup
Before using other commands, set your Contiguity API token using the following
command:
```bash
$ contiguity set-token
```
## Building
Deno, Node.js, and Pandoc are required to build the CLI. To install them, run
the following commands:
```bash
# Windows
$ winget install DenoLand.Deno OpenJS.NodeJS JohnMacFarlane.Pandoc
# macOS
$ brew install deno node pandoc
# Ubuntu, Debian, and derivatives
$ sudo apt install nodejs pandoc && curl -fsSL https://deno.land/install.sh | sh
# Arch Linux, Manjaro, and derivatives
$ sudo pacman -S deno nodejs pandoc
# Red Hat, Fedora, and derivatives
$ sudo dnf install nodejs pandoc && curl -fsSL https://deno.land/install.sh | sh
# Void Linux
$ sudo xbps-install nodejs pandoc && curl -fsSL https://deno.land/install.sh | sh
```
Then, run the following command to build the CLI:
```bash
deno task build
```
The built CLI will be in `./npm`. You can test it by running `npm i -g ./npm` to
install the built CLI globally.
If you have a `man` program on your system (aka you aren't on Windows), you can
also run this command to build and preview the man page:
```bash
deno task preview-man
```
You can run the cli without building it by running this command:
```bash
deno task cli --help
```