Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@based/cli

Package Overview
Dependencies
Maintainers
1
Versions
189
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@based/cli

## Concept

  • 0.5.0
  • npm
  • Socket score

Version published
Weekly downloads
306
increased by385.71%
Maintainers
1
Weekly downloads
 
Created
Source

Based CLI

Concept

- There should be two main modes: interactive and non-interactive.
- Items that should be clearly visible when the command runs:
	- cli version
	- cluster, org, project, env
	- command being run
- Different steps in the command should be clear with some kind of separator.
- When needed should authenticate the user first.
- Main arguments should be confirmed with inputs, and prepopulated in case they exist.

Syntax

`based [...global arguments] command [...command arguments]`

Global arguments

- `--non-interactive`: Run in non interactive mode. Also infered from isTTY.
- `--org <org>`: Org
- `-p, --project <project>`: Project
- `-e, --env <env>`
- `--cluster <cluster>`: Cluster
- `-b, --based-file <basedFile>: Path to based config file. Defualts to `based.json` in the current folder
- `-d, --debug`: Show debug information
- `-o, --output-type <output-type>`: Output type: `fancy` (default), `json`

Commands

envs <action>

Manage environments in the cluster.

Actions:

- `ls`: List envs
- `add`: Add and environment
- `remove`: Remove an environment
ls action

Flow:

- get cluster
- authenticate user
- list existing envs
add action

Flow:

- get cluster, org, project, env from file or arguments
- ask for env name if not in based file or arguments
- create env
- (?)

FAQs

Package last updated on 02 Mar 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc