@heroku-cli/plugin-run-v5/commands/run/detached.js

Heroku CLI plugin to run one-off dyno processes.

'use strict'

let cli = require('heroku-cli-util')
let helpers = require('../../lib/helpers')
let logDisplayer = require('../../lib/log_displayer')
let Dyno = require('../../lib/dyno')
const {DynoSizeCompletion, ProcessTypeCompletion} = require('@heroku-cli/command/lib/completions')

async function run(context, heroku) {
  let opts = {
    heroku: heroku,
    app: context.app,
    command: helpers.buildCommand(context.args),
    size: context.flags.size,
    type: context.flags.type,
    env: context.flags.env,
    attach: false,
  }
  if (!opts.command) throw new Error('Usage: heroku run COMMAND\n\nExample: heroku run bash')
  let dyno = new Dyno(opts)
  await dyno.start()

  if (context.flags.tail) {
    await logDisplayer(heroku, {
      app: context.app,
      dyno: dyno.dyno.name,
      tail: true,
    })
  } else {
    cli.log(`Run ${cli.color.cmd('heroku logs --app ' + dyno.opts.app + ' --dyno ' + dyno.dyno.name)} to view the output.`)
  }
}

module.exports = {
  topic: 'run',
  command: 'detached',
  description: 'run a detached dyno, where output is sent to your logs',
  examples: `$ heroku run:detached ls
Running ls on app [detached]... up, run.1
Run heroku logs -a app -p run.1 to view the output.`,
  variableArgs: true,
  needsAuth: true,
  needsApp: true,
  flags: [
    {name: 'size', char: 's', description: 'dyno size', hasValue: true, completion: DynoSizeCompletion},
    {name: 'tail', char: 't', description: 'stream logs from the dyno'},
    {name: 'type', description: 'process type', hasValue: true, completion: ProcessTypeCompletion},
    {name: 'env', char: 'e', description: "environment variables to set (use ';' to split multiple vars)", hasValue: true},
  ],
  run: cli.command(run),
}