Skip to content

Commit

Permalink
fix(name): Changed the name to one that was available on npm :P
Browse files Browse the repository at this point in the history
  • Loading branch information
kerren committed Mar 11, 2022
1 parent c85c49f commit 441f35c
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 74 deletions.
132 changes: 66 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
local-https-dev
certme
=================

A CLI used to create a local https dev environment with the green lock.
Expand Down Expand Up @@ -43,17 +43,17 @@ Once the CLI is installed, you need to register your system username (the certif
And example of the commands would be as follows, you'll notice that it must be run as `sudo` since it edits the `/etc/hosts` file and creates an `nginx` config file.

```bash
sudo local-https-dev user:register kerren
sudo local-https-dev domain:register --domain=mytestdomain.com --port=9000
sudo certme user:register kerren
sudo certme domain:register --domain=mytestdomain.com --port=9000
```

And that should be it! Visit [https://mytestdomain.com](https://mytestdomain.com) and you should see the green lock!

![](./assets/local-https-dev_eg1.png)
![](./assets/certme_eg1.png)

Now if you visit the domain:

![](./assets/local-https-dev_eg2.png)
![](./assets/certme_eg2.png)


# Roadmap
Expand All @@ -67,69 +67,69 @@ This was my "POC" to ensure that I wasn't crazy and that it was possible to get
# Usage
<!-- usage -->
```sh-session
$ npm install -g local-https-dev
$ local-https-dev COMMAND
$ npm install -g certme
$ certme COMMAND
running command...
$ local-https-dev (--version)
local-https-dev/0.0.0 linux-x64 node-v16.14.0
$ local-https-dev --help [COMMAND]
$ certme (--version)
certme/0.0.0 linux-x64 node-v16.14.0
$ certme --help [COMMAND]
USAGE
$ local-https-dev COMMAND
$ certme COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`local-https-dev domain clear-all`](#local-https-dev-domain-clear-all)
* [`local-https-dev domain list`](#local-https-dev-domain-list)
* [`local-https-dev domain register`](#local-https-dev-domain-register)
* [`local-https-dev domain remove`](#local-https-dev-domain-remove)
* [`local-https-dev help [COMMAND]`](#local-https-dev-help-command)
* [`local-https-dev plugins`](#local-https-dev-plugins)
* [`local-https-dev plugins:inspect PLUGIN...`](#local-https-dev-pluginsinspect-plugin)
* [`local-https-dev plugins:install PLUGIN...`](#local-https-dev-pluginsinstall-plugin)
* [`local-https-dev plugins:link PLUGIN`](#local-https-dev-pluginslink-plugin)
* [`local-https-dev plugins:uninstall PLUGIN...`](#local-https-dev-pluginsuninstall-plugin)
* [`local-https-dev plugins update`](#local-https-dev-plugins-update)
* [`local-https-dev user register USER`](#local-https-dev-user-register-user)

## `local-https-dev domain clear-all`
* [`certme domain clear-all`](#certme-domain-clear-all)
* [`certme domain list`](#certme-domain-list)
* [`certme domain register`](#certme-domain-register)
* [`certme domain remove`](#certme-domain-remove)
* [`certme help [COMMAND]`](#certme-help-command)
* [`certme plugins`](#certme-plugins)
* [`certme plugins:inspect PLUGIN...`](#certme-pluginsinspect-plugin)
* [`certme plugins:install PLUGIN...`](#certme-pluginsinstall-plugin)
* [`certme plugins:link PLUGIN`](#certme-pluginslink-plugin)
* [`certme plugins:uninstall PLUGIN...`](#certme-pluginsuninstall-plugin)
* [`certme plugins update`](#certme-plugins-update)
* [`certme user register USER`](#certme-user-register-user)

## `certme domain clear-all`

Removes all of the registered domains

```
USAGE
$ local-https-dev domain clear-all
$ certme domain clear-all
DESCRIPTION
Removes all of the registered domains
EXAMPLES
$ local-https-dev domain clear-all
$ certme domain clear-all
```

## `local-https-dev domain list`
## `certme domain list`

Lists the existing domains that have been registered

```
USAGE
$ local-https-dev domain list
$ certme domain list
DESCRIPTION
Lists the existing domains that have been registered
EXAMPLES
$ local-https-dev domain list
$ certme domain list
```

## `local-https-dev domain register`
## `certme domain register`

Registers a new domain, creates the certificate, nginx config update and a change in the hosts file.

```
USAGE
$ local-https-dev domain register -d <value> [-p <value>]
$ certme domain register -d <value> [-p <value>]
FLAGS
-d, --domain=<value> (required) The domain that you would like to add to the system
Expand All @@ -139,16 +139,16 @@ DESCRIPTION
Registers a new domain, creates the certificate, nginx config update and a change in the hosts file.
EXAMPLES
$ local-https-dev domain register
$ certme domain register
```

## `local-https-dev domain remove`
## `certme domain remove`

Remove a domain from the registered domains

```
USAGE
$ local-https-dev domain remove -d <value>
$ certme domain remove -d <value>
FLAGS
-d, --domain=<value> (required) The domain that you would like to remove from the system
Expand All @@ -157,16 +157,16 @@ DESCRIPTION
Remove a domain from the registered domains
EXAMPLES
$ local-https-dev domain remove
$ certme domain remove
```

## `local-https-dev help [COMMAND]`
## `certme help [COMMAND]`

Display help for local-https-dev.
Display help for certme.

```
USAGE
$ local-https-dev help [COMMAND] [-n]
$ certme help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
Expand All @@ -175,18 +175,18 @@ FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for local-https-dev.
Display help for certme.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_

## `local-https-dev plugins`
## `certme plugins`

List installed plugins.

```
USAGE
$ local-https-dev plugins [--core]
$ certme plugins [--core]
FLAGS
--core Show core plugins.
Expand All @@ -195,18 +195,18 @@ DESCRIPTION
List installed plugins.
EXAMPLES
$ local-https-dev plugins
$ certme plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_

## `local-https-dev plugins:inspect PLUGIN...`
## `certme plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
$ local-https-dev plugins:inspect PLUGIN...
$ certme plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
Expand All @@ -219,16 +219,16 @@ DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ local-https-dev plugins:inspect myplugin
$ certme plugins:inspect myplugin
```

## `local-https-dev plugins:install PLUGIN...`
## `certme plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
$ local-https-dev plugins:install PLUGIN...
$ certme plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
Expand All @@ -250,23 +250,23 @@ DESCRIPTION
the CLI without the need to patch and update the whole CLI.
ALIASES
$ local-https-dev plugins add
$ certme plugins add
EXAMPLES
$ local-https-dev plugins:install myplugin
$ certme plugins:install myplugin
$ local-https-dev plugins:install https://github.com/someuser/someplugin
$ certme plugins:install https://github.com/someuser/someplugin
$ local-https-dev plugins:install someuser/someplugin
$ certme plugins:install someuser/someplugin
```

## `local-https-dev plugins:link PLUGIN`
## `certme plugins:link PLUGIN`

Links a plugin into the CLI for development.

```
USAGE
$ local-https-dev plugins:link PLUGIN
$ certme plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
Expand All @@ -284,16 +284,16 @@ DESCRIPTION
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ local-https-dev plugins:link myplugin
$ certme plugins:link myplugin
```

## `local-https-dev plugins:uninstall PLUGIN...`
## `certme plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
$ local-https-dev plugins:uninstall PLUGIN...
$ certme plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
Expand All @@ -306,17 +306,17 @@ DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ local-https-dev plugins unlink
$ local-https-dev plugins remove
$ certme plugins unlink
$ certme plugins remove
```

## `local-https-dev plugins update`
## `certme plugins update`

Update installed plugins.

```
USAGE
$ local-https-dev plugins update [-h] [-v]
$ certme plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
Expand All @@ -326,13 +326,13 @@ DESCRIPTION
Update installed plugins.
```

## `local-https-dev user register USER`
## `certme user register USER`

Register a user that is on the system so that we can edit the trust servers for their account

```
USAGE
$ local-https-dev user register [USER]
$ certme user register [USER]
ARGUMENTS
USER The username for the account using the browser (eg. run "whoami")
Expand All @@ -341,6 +341,6 @@ DESCRIPTION
Register a user that is on the system so that we can edit the trust servers for their account
EXAMPLES
$ local-https-dev user register
$ certme user register
```
<!-- commandsstop -->
17 changes: 9 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "local-https-dev",
"name": "certme",
"version": "0.0.0",
"description": "A CLI to add and remove local development environments and create https certificates for them.",
"author": "Kerren @Kerren-Entrostat",
"bin": {
"local-https-dev": "./bin/run"
"certme": "./bin/run"
},
"homepage": "https://github.com/Kerren-Entrostat/local-https-dev",
"homepage": "https://github.com/Kerren-Entrostat/certme",
"license": "MIT",
"main": "dist/index.js",
"repository": "Kerren-Entrostat/local-https-dev",
"repository": "Kerren-Entrostat/certme",
"files": [
"/bin",
"/dist",
Expand Down Expand Up @@ -45,8 +45,8 @@
"typescript": "^4.4.3"
},
"oclif": {
"bin": "local-https-dev",
"dirname": "local-https-dev",
"bin": "certme",
"dirname": "certme",
"commands": "./dist/commands",
"plugins": [
"@oclif/plugin-help",
Expand All @@ -68,12 +68,13 @@
"posttest": "yarn lint",
"prepack": "yarn build && oclif manifest && oclif readme",
"test": "mocha --forbid-only \"test/**/*.test.ts\"",
"version": "oclif readme && git add README.md"
"version": "oclif readme && git add README.md",
"release": "entro-version --during-release-post-hook=\"npm publish && git commit -am 'Updated the readme'\""
},
"engines": {
"node": ">=14.0.0"
},
"bugs": "https://github.com/Kerren-Entrostat/local-https-dev/issues",
"bugs": "https://github.com/Kerren-Entrostat/certme/issues",
"keywords": [
"oclif"
],
Expand Down

0 comments on commit 441f35c

Please sign in to comment.