# @corejam/cli

> Corejam CLI package.

Latest version **0.0.26** (published 2021-03-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @corejam/cli
pnpm add @corejam/cli
yarn add @corejam/cli
bun add @corejam/cli
```

Provides the command `corejam`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.26 |
| Published | 2021-03-22 |
| First published | 2020-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 24 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Maintainers | mattvb91, patrickhaug |
| Keywords | cli, stenciljs, stencil-components, graphql, graqhql-server, typescript, web-components, static-site-generator |

## Links

- npm: https://www.npmjs.com/package/@corejam/cli
- Repository: https://github.com/Corejam/Corejam
- Homepage: https://corejam.io/
- Issues: https://github.com/corejam/corejam/issues
- npm.io page: https://npm.io/package/@corejam/cli

## Dependencies (24)

- [ora](https://npm.io/package/ora.md) 5.3.0
- [cors](https://npm.io/package/cors.md) 2.8.5
- [sade](https://npm.io/package/sade.md) 1.7.4
- [chalk](https://npm.io/package/chalk.md) 4.1.0
- [execa](https://npm.io/package/execa.md) 5.0.0
- [kleur](https://npm.io/package/kleur.md) 4.1.4
- [micro](https://npm.io/package/micro.md) 9.3.4
- [serve](https://npm.io/package/serve.md) 11.3.2
- [dotenv](https://npm.io/package/dotenv.md) 8.2.0
- [is-npm](https://npm.io/package/is-npm.md) 5.0.0
- [prepend](https://npm.io/package/prepend.md) 1.0.2
- [chokidar](https://npm.io/package/chokidar.md) 3.5.1
- [copyfiles](https://npm.io/package/copyfiles.md) 2.4.1
- [kill-port](https://npm.io/package/kill-port.md) 1.6.1
- [fs-jetpack](https://npm.io/package/fs-jetpack.md) 4.1.0
- [micro-cors](https://npm.io/package/micro-cors.md) 0.1.1
- [log-symbols](https://npm.io/package/log-symbols.md) 4.0.0
- [@types/micro](https://npm.io/package/@types/micro.md) 7.3.3
- [@types/react](https://npm.io/package/@types/react.md) 17.0.3
- [@corejam/base](https://npm.io/package/@corejam/base.md) 0.0.14
- [@types/archiver](https://npm.io/package/@types/archiver.md) 5.1.0
- [replace-in-file](https://npm.io/package/replace-in-file.md) 6.2.0
- [@types/object-hash](https://npm.io/package/@types/object-hash.md) 1.3.4
- [apollo-server-micro](https://npm.io/package/apollo-server-micro.md) 2.21.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.26 (latest) — 2021-03-22
- 0.0.26-alpha.341 (next) — 2021-03-13
- 0.0.26-alpha.333 — 2021-03-11
- 0.0.25 — 2021-03-08
- 0.0.25-alpha.307 — 2021-03-03
- 0.0.24 — 2021-02-26
- 0.0.24-alpha.210 — 2021-02-19
- 0.0.23 — 2021-02-16
- 0.0.23-alpha.201 — 2021-02-16
- 0.0.23-alpha.132 — 2021-02-02
- 0.0.22 — 2021-01-29
- 0.0.22-alpha.96 — 2021-01-29
- 0.0.21 — 2021-01-27
- 0.0.20 — 2021-01-13
- 0.0.20-alpha.56 — 2021-01-11
- … 20 more at https://npm.io/package/@corejam/cli/versions

## README

# Corejam 

### Usage

Corejam is a scaffolding for building progressive GraphQL powered jamstack applications.

```bash
npm i -g @corejam/cli
```

To get started with a new project, run the following command:

```bash
corejam createApp <NAME>    # create new project
cd <NAME>                   # change into project directory
corejam dev                 # start the corejam dev playground

# GraphQL playground will be available on localhost:3000
# StencilJS playground will be available on localhost:3001
```

### Documentation

```bash
  Usage
    $ corejam <command> [options]

  Available Commands
    build             Build the whole plugin source
    dev               Plugin dev process
    api:serve         Start graphql Server
    api:dev           Start graphql server and set up hot reloading
    createApp         Bootstraps new corejam app
    generateSchema    
    test              
    test:wc           
    static            build static html from app
    static:serve      Serve static folder

  For more info, run any command with the `--help` flag
    $ corejam build --help
    $ corejam dev --help

  Options
    -v, --version    Displays current version
    -h, --help       Displays this message
   
```

### Env vars (move to correct package)

We need to define different env variables for the following use cases: dev, pre-render (static html), ssr (production)

Dev, static: client url has to be prefixed because we are running on 2 different ports (3001 stenciljs, 3000 api). Client url has to be prefixed for client bundle + hydration. 

Production: url has to be prefixed with absolute url for hydration. Client bundle without prefix due to same origin

---
_Source: https://npm.io/package/@corejam/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._