https://github.com/artdecocode/dokku
The CLI Utility To Control A Remote Dokku Host.
https://github.com/artdecocode/dokku
Last synced: 11 months ago
JSON representation
The CLI Utility To Control A Remote Dokku Host.
- Host: GitHub
- URL: https://github.com/artdecocode/dokku
- Owner: artdecocode
- License: mit
- Created: 2019-03-18T15:56:10.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-03-05T06:58:10.000Z (almost 6 years ago)
- Last Synced: 2024-04-29T15:06:08.539Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://artd.eco
- Size: 39.1 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dokku
[](https://www.npmjs.com/package/dokku)
`dokku` is The CLI Utility To Control A Remote Dokku Host.
```sh
yarn add dokku
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [CLI](#cli)
- [Commands](#commands)
* [`config:env`](#configenv)
- [Copyright](#copyright)
## CLI
The program is compiled to be used from the CLI. The program is still under development.
Argument
Short
Description
command
The command to execute.
--host
The host. If not given, reads executes git remote and uses dokku record.
--app
-a
The app. If not given, reads executes git remote and uses dokku record.
--user
Dokku user, used to look the host from git remote, and to connect. Default dokku.
When run without the host and app arguments, `dokku` will execute `git remote -v` command, and extract those records that sign in with the dokku user. If there are more than one apps, the `app` is required.
After that, each command will be constructed in the following way:
```sh
# dokku command ...rest
ssh command ...rest
# e.g.,
# dokku config:set KEY=VALUE
ssh config:set KEY=VALUE
```
## Commands
The full list of commands is the same as what Dokku supports. There are some special commands.
### `config:env`
The special `config:env` command will read the `.env` file, and execute the `config:set KEY=VALUE` command.
```sh
dokku config:env
```
```
Will connect to dokku@artd.eco:example
config:set example HELLO=world DOKKU=node.js
-----> Setting config vars
HELLO: world
DOKKU: node.js
-----> Restarting app example
```
## Copyright
© Art Deco™ 2020
