Skip to content

Commit

Permalink
Remove a bunch of code
Browse files Browse the repository at this point in the history
Signed-off-by: macdonst <simon.macdonald@gmail.com>
  • Loading branch information
macdonst committed Mar 24, 2023
1 parent abeda03 commit fc681b1
Show file tree
Hide file tree
Showing 77 changed files with 76 additions and 2,812 deletions.
65 changes: 0 additions & 65 deletions .github/workflows/binary-build.yml

This file was deleted.

2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Begin CLI
Enhance CLI
Copyright 2022 Beginner Corp

This product includes software developed at
Expand Down
12 changes: 4 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@begin/cli",
"version": "0.12.3",
"name": "@enhance/cli",
"version": "0.0.1",
"bin": {
"begin": "src/index.js"
"enhance": "src/index.js"
},
"main": "src/index.js",
"engines": {
Expand All @@ -14,10 +14,7 @@
"test:integration": "cross-env NODE_ENV=testing tape 'test/integration/**/*-test.js' | tap-arc",
"test:integration:slow": "cross-env NODE_ENV=testing tape 'test/integration/**/*-test-slow.js' | tap-arc",
"coverage": "nyc --reporter=lcov --reporter=text npm run test:unit",
"lint": "eslint . --fix",
"build": "cross-env scripts/binary-config && npx pkg scripts --compress GZip && rm -f commit",
"publish": "BUILD_ALL=true npm run build && scripts/publish",
"deploy": "scripts/deploy"
"lint": "eslint . --fix"
},
"license": "Apache-2.0",
"dependencies": {
Expand Down Expand Up @@ -60,7 +57,6 @@
"eslint": "8.36.0",
"fs-extra": "~11.1.0",
"nyc": "^15.1.0",
"pkg": "~5.8.0",
"proxyquire": "~2.1.3",
"string-argv": "~0.3.1",
"tap-arc": "~0.3.5",
Expand Down
22 changes: 11 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Begin CLI
# Enhance CLI

[![GitHub CI status](https://github.com/beginner-corp/cli/workflows/Node%20CI/badge.svg)](https://github.com/beginner-corp/cli/actions?query=workflow%3A%22Node+CI%22)


## Installing

Install the Begin CLI by opening your terminal and entering the following command:
Install the Enhance CLI by opening your terminal and entering the following command:

- Mac, Linux: `curl -sS https://dl.begin.com/install.sh | sh`
- Then follow the printed instructions to add Begin to your `$PATH`.
- Then follow the printed instructions to add Enhance to your `$PATH`.
- Windows: `iwr https://dl.begin.com/install.ps1 -useb | iex`

By default Begin installs to `~/.begin/` (Mac, Linux) / `$Home\.begin\` (Windows). You can specify a custom directory to install to by using the `BEGIN_INSTALL` environment variable:
By default Enhance installs to `~/.begin/` (Mac, Linux) / `$Home\.begin\` (Windows). You can specify a custom directory to install to by using the `BEGIN_INSTALL` environment variable:

- Mac, Linux: `BEGIN_INSTALL=/whatever/path/here curl -sS https://dl.begin.com/install.sh | sh`
- Windows: `$env:BEGIN_INSTALL="c:\whatever\path\here"; iwr https://dl.begin.com/install.ps1 -useb | iex`

Alternatively, you can install Begin with npm: `npm i -g @begin/cli`.
Alternatively, you can install Enhance with npm: `npm i -g @begin/cli`.

## Running locally

Expand All @@ -30,7 +30,7 @@ export BEGIN_CLI_CLIENT_ID_PRODUCTION=<your production ID>

## Usage

> Note for Windows users: `begin` is a reserved word in PowerShell, so in Windows Begin is `b.exe`. Any documented references to running `begin` should be interpreted as running `b` in Windows.
> Note for Windows users: `begin` is a reserved word in PowerShell, so in Windows Enhance is `b.exe`. Any documented references to running `begin` should be interpreted as running `b` in Windows.
- Run `begin` to see your list of available commands
- Get help:
Expand Down Expand Up @@ -65,7 +65,7 @@ Unsuccessful execution

## CLI release channels

Begin has two release channels:
Enhance has two release channels:

- `latest` (default) - well-hardened production releases following [semver](https://semver.org/)
- `main` - the newest stuff (on the `main` branch, hence the name), not yet released to production
Expand All @@ -74,15 +74,15 @@ To install main directly, run:
- Mac, Linux: `curl -s https://dl.begin.com/install.sh | sh -s main`
- Windows: `$v="main"; iwr https://dl.begin.com/install.ps1 -useb | iex`

If you already have Begin installed, to switch to `main` from `latest` run: `begin update --use main`.
If you already have Enhance installed, to switch to `main` from `latest` run: `begin update --use main`.

Similarly, to switch back to `latest` from `main`, run: `begin update --use latest`.


## Tidbits

Wherever possible, the Begin CLI adheres to the [Command Line Interface Guidelines](https://clig.dev/).
Wherever possible, the Enhance CLI adheres to the [Command Line Interface Guidelines](https://clig.dev/).

Begin is `async/await` / `Promises`-based, and uses `pkg` for binary compilation. It is currently CommonJS, with plans to [eventually refactor to ESM](https://github.com/vercel/pkg/issues/1291).
Enhance is `async/await` / `Promises`-based, and uses `pkg` for binary compilation. It is currently CommonJS, with plans to [eventually refactor to ESM](https://github.com/vercel/pkg/issues/1291).

Begin is written in idiomatic JavaScript with a key exception: each command's specific `require()` statements are in local scope, not global. This is specifically and deliberately done to [reduce the coldstart time and ensure every execution runs as fast as possible](https://github.com/beginner-corp/cli/discussions/4).
Enhance is written in idiomatic JavaScript with a key exception: each command's specific `require()` statements are in local scope, not global. This is specifically and deliberately done to [reduce the coldstart time and ensure every execution runs as fast as possible](https://github.com/beginner-corp/cli/discussions/4).
110 changes: 0 additions & 110 deletions scripts/binary-config

This file was deleted.

73 changes: 0 additions & 73 deletions scripts/deploy

This file was deleted.

31 changes: 0 additions & 31 deletions scripts/lib/index.js

This file was deleted.

Loading

0 comments on commit fc681b1

Please sign in to comment.