/** * @license * Copyright 2016-2020 Balena Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { flags } from '@oclif/command'; import { stripIndent } from 'common-tags'; import * as _ from 'lodash'; import Command from '../command'; import { ExpectedError } from '../errors'; import * as cf from '../utils/common-flags'; import { getBalenaSdk } from '../utils/lazy'; interface FlagsDef { device?: string; // device UUID dev?: string; // Alias for device. help: void; } interface ArgsDef { note: string; } export default class NoteCmd extends Command { public static description = stripIndent` Set a device note. Set or update a device note. If the note argument is not provided, it will be read from stdin. To view device notes, use the \`balena device \` command. `; public static examples = [ '$ balena note "My useful note" --device 7cf02a6', '$ cat note.txt | balena note --device 7cf02a6', ]; public static args = [ { name: 'note', description: 'note content', }, ]; public static usage = 'note <|note>'; public static flags: flags.Input = { device: { exclusive: ['dev'], ...cf.device }, dev: flags.string({ exclusive: ['device'], hidden: true, }), help: cf.help, }; public static authenticated = true; public static readStdin = true; public async run() { const { args: params, flags: options } = this.parse( NoteCmd, ); params.note = params.note || this.stdin; if (_.isEmpty(params.note)) { throw new ExpectedError('Missing note content'); } options.device = options.device || options.dev; delete options.dev; if (_.isEmpty(options.device)) { throw new ExpectedError('Missing device UUID (--device)'); } const balena = getBalenaSdk(); return balena.models.device.note(options.device!, params.note); } }