prismify-co/ko

A project scaffolding CLI for the web

ko

A project scaffolding and configuration CLI for the web

• ko
• About
• Usage
• Commands

About

ko is a (WIP) project scaffolding and configuration tool that is meant to easily create or clone projects like Nuxt.js, Next.js, and Sapper.

This project is heavily inspired¹ by Blitz. Blitz is a Ruby on Rails like project based on Next.js. Blitz also allows you to configure the project by using their CLI. However, rather than building a web framework, this project focuses on the configuration portion of their CLI and aims to target different frameworks.

At the time of this writng, ko can generate a basic Next.js app and clone repositories from GitHub, GitLab, and Bitbucket.

¹ Before knowing about Blitz, I had created a Nuxt.js configurator that took a simiar approach.

Features

• Generate Next.js projects
• ⚠️ Experimental Configure the project via Recipes

Roadmap

• Support other frameworks like Nuxt.js and Sapper
• Support for Docker (?)
• Add run command (e.g. installing a list of recipes from ko.config.json)

Get Started

1. Create the project

Create a Next.js app using TypeScript

ko create hello

Create a Next.js app using JavaScript

ko create hello --javascript # or -j

2. Configure the project

cd into the project

cd hello

Install Chakra

ko install chakra

3. Start developing!

yarn dev

Usage

$ npm install -g @prismify/ko
$ ko COMMAND
running command...
$ ko (-v|--version|version)
@prismify/ko/0.4.0 darwin-x64 node-v16.1.0
$ ko --help [COMMAND]
USAGE
  $ ko COMMAND
...

Commands

• ko clone REPOSITORY [DESTINATION]
• ko create NAME
• ko help [COMMAND]
• ko install NAME

ko clone REPOSITORY [DESTINATION]

clone an existing project

USAGE
  $ ko clone REPOSITORY [DESTINATION]

ARGUMENTS
  REPOSITORY   The repository url (e.g. org/repo, github:org/repo, https://www.github.com/org/repo)
  DESTINATION  The destination to clone (optional)

See code: lib/packages/cli/clone.js

ko create NAME

create a new project

USAGE
  $ ko create NAME

ARGUMENTS
  NAME  The name of the project or "." for cwd

OPTIONS
  -f, --framework=next   [default: next]
  -j, --javascript       Use JavaScript
  -p, --prompt
  -v, --version=version  [default: latest]
  --no-git
  --offline

ALIASES
  $ ko new

See code: lib/packages/cli/create.js

ko help [COMMAND]

display help for ko

USAGE
  $ ko help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

ko install NAME

install the recipe and configure the app

USAGE
  $ ko install NAME

ARGUMENTS
  NAME  The name of the recipe or the repository where the recipe (e.g. "tailwind", org/repo, github:org/repo)

OPTIONS
  -c, --no-cache
  -d, --dryRun
  -f, --offline
  -g, --no-git
  -p, --prompt
  --host=github|gitlab|bitbucket  [default: github]

ALIASES
  $ ko add

See code: lib/packages/cli/install.js