Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

stdin and env documentation #31

Merged
merged 1 commit into from
Feb 10, 2024
Merged

stdin and env documentation #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,16 @@ var Docker = dockerCLI.Docker;

## Usage

### DockerCLI Options

| Option | Type | Description |
| ------------------------- | ------------------- | ----------------------------------------------------------------- |
| `machineName` | `string` | The name of the Docker machine. |
| `currentWorkingDirectory` | `string` | The current working directory where Docker commands are executed. |
| `echo` | `boolean` | If true, the Docker commands are echoed to the console. |
| `env` | `NodeJS.ProcessEnv` | The environment variables for the Docker process. |
| `stdin` | `string` | The standard input for the Docker process. |

### Modern JS - direct call

```js
Expand All @@ -39,6 +49,8 @@ const options = {
machineName: null, // uses local docker
currentWorkingDirectory: null, // uses current working directory
echo: true, // echo command output to stdout/stderr
env: null, // environment variables
stdin: null, // stdin used for the command (useful for passing passwords, etc)
};

const data = await dockerCommand('build -t nginximg .', options);
Expand Down Expand Up @@ -599,16 +611,18 @@ docker.command('search nginxcont').then(function (data) {

* docker login

Please use **--password-stdin** for **secure** login

```js
docker.command('login -u myusername -p mypassword').then(function (data) {
docker.command('login -u myusername --password-stdin').then(function (data) {
console.log('data = ', data);
// Successful login
}, function (rejected) {
console.log('rejected = ', rejected);
// Failed login
});

// data = { command: 'docker login -u myusername -p mypassword ',
// data = { command: 'docker login -u myusername --password-stdin ',
// raw: 'Login Succeeded\n',
// login: 'Login Succeeded' }

Expand Down