0.4.0 • Published 2 years ago

@prismify/ko v0.4.0

Weekly downloads
100
License
MIT
Repository
github
Last release
2 years ago

ko

A project scaffolding and configuration CLI for the web

Node CI codecov oclif Version Downloads/week License

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[1](#one) 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.

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

Features

  • Generate Next.js projects
  • :warning: 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]

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

0.4.0

2 years ago

0.3.13

3 years ago

0.3.12

3 years ago

0.3.11

3 years ago

0.3.9

3 years ago

0.3.10

3 years ago

0.3.8

3 years ago

0.3.7

3 years ago

0.3.6

4 years ago

0.3.5

4 years ago

0.3.4

4 years ago

0.3.3

4 years ago

0.1.0-7

4 years ago

0.1.0-6

4 years ago

0.1.0

4 years ago

0.3.0

4 years ago

0.2.0

4 years ago

0.3.2

4 years ago

0.3.1

4 years ago

0.1.0-5

4 years ago

0.1.0-4

4 years ago

0.1.0-3

4 years ago

0.1.0-2

4 years ago

0.1.0-1

4 years ago

0.1.0-0

4 years ago

0.0.24

4 years ago

0.0.25

4 years ago

0.0.23

4 years ago

0.0.22

4 years ago

0.0.21

4 years ago

0.0.20

4 years ago

0.0.18

4 years ago

0.0.19

4 years ago

0.0.17

4 years ago

0.0.14

4 years ago

0.0.15

4 years ago

0.0.16

4 years ago

0.0.13

4 years ago

0.0.12

4 years ago

0.0.10

4 years ago

0.0.11

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.1

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1-2

4 years ago

0.0.1-1

4 years ago

0.0.1-0

4 years ago