Skip to content

aj-archipelago/cortex-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Multiple CLI Applications Repository

This repository contains multiple command-line interface (CLI) applications, each designed to leverage different tools and services.

Repository Structure

.
├── cortex-cli
├── gdnote
├── gdreview
├── install.sh
└── recat

Applications

Cortex CLI

The cortex-cli is a CLI application that interacts with the Cortex API, allowing users to execute a variety of commands.

Installation

Navigate to the cortex-cli directory and run:

$ npm install

Usage

This script executes Cortex pathways as commands through the command line. Sample usage:

$ cortex-cli <command> [options]

Full documentation can be found in the cortex-cli directory's README.

GDNote

The gdnote CLI compiles release notes for a git branch by sending a diff of the branch to a Cortex API endpoint.

Installation

Navigate to the gdnote directory and run:

$ npm install

Usage

Run the gdnote script with the branch name to compare the current branch with as an argument:

$ gdnote <branch_name>

GDReview

The gdreview CLI performs a code review for a git branch by sending a diff of the branch to a Cortex API endpoint.

Installation

Navigate to the gdreview directory and run:

$ npm install

Usage

Run the gdreview script with the branch name to compare the current branch with as an argument:

$ gdreview <branch_name>

Recat

The recat CLI recursively prints the directory structure and select source files from the current directory down. It is typically used to generate a text block to feed to Cortex pathways that work on source code.

Installation

Navigate to the recat directory and run:

$ npm install

Usage

Run the recat script with the directory name as an argument:

$ recat <directory>

Development

This project uses Node.js and npm. Ensure they are both installed. Then install the project dependencies using npm:

$ npm install

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

Shell interface for Archipelago Cortex

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published