mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-29 10:08:51 +00:00
87 lines
2.3 KiB
TypeScript
87 lines
2.3 KiB
TypeScript
/**
|
|
* @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 Command from '../../command';
|
|
import { ExpectedError } from '../../errors';
|
|
import * as cf from '../../utils/common-flags';
|
|
import { getBalenaSdk } from '../../utils/lazy';
|
|
|
|
interface FlagsDef {
|
|
help: void;
|
|
}
|
|
|
|
interface ArgsDef {
|
|
name: string;
|
|
}
|
|
|
|
export default class GenerateCmd extends Command {
|
|
public static description = stripIndent`
|
|
Generate a new balenaCloud API key.
|
|
|
|
Generate a new balenaCloud API key for the current user, with the given
|
|
name. The key will be logged to the console.
|
|
|
|
This key can be used to log into the CLI using 'balena login --token <key>',
|
|
or to authenticate requests to the API with an 'Authorization: Bearer <key>' header.
|
|
`;
|
|
public static examples = ['$ balena api-key generate "Jenkins Key"'];
|
|
|
|
public static args = [
|
|
{
|
|
name: 'name',
|
|
description: 'the API key name',
|
|
required: true,
|
|
},
|
|
];
|
|
|
|
public static usage = 'api-key generate <name>';
|
|
|
|
public static flags: flags.Input<FlagsDef> = {
|
|
help: cf.help,
|
|
};
|
|
|
|
public static authenticated = true;
|
|
|
|
public async run() {
|
|
const { args: params } = this.parse<FlagsDef, ArgsDef>(GenerateCmd);
|
|
|
|
let key;
|
|
try {
|
|
key = await getBalenaSdk().models.apiKey.create(params.name);
|
|
} catch (e) {
|
|
if (e.name === 'BalenaNotLoggedIn') {
|
|
throw new ExpectedError(stripIndent`
|
|
This command cannot be run when logged in with an API key.
|
|
Please login again with 'balena login' and select an alternative method.
|
|
`);
|
|
} else {
|
|
throw e;
|
|
}
|
|
}
|
|
|
|
console.log(stripIndent`
|
|
Registered api key '${params.name}':
|
|
|
|
${key}
|
|
|
|
This key will not be shown again, so please save it now.
|
|
`);
|
|
}
|
|
}
|