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

@okam/cli

Package Overview
Dependencies
Maintainers
0
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@okam/cli

Internal CLI for Okam's development workflows.

  • 1.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
0
Weekly downloads
 
Created
Source

okam-cli

Internal CLI for Okam's development workflows.

oclif Version Downloads/week

Usage

$ npm install -g @okam/cli
$ okam COMMAND
running command...
$ okam (--version)
@okam/cli/1.1.0 darwin-arm64 node-v22.8.0
$ okam --help [COMMAND]
USAGE
  $ okam COMMAND
...

Commands

okam env-sync

Manage environment variables with Bitwarden

USAGE
  $ okam env-sync [-f] [-n <value>]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  Manage environment variables with Bitwarden

EXAMPLES
  $ okam env-sync push <file>

  $ okam env-sync pull

  $ okam env-sync list

See code: src/commands/env-sync/index.ts

okam env-sync init

Initialize env-sync configuration

USAGE
  $ okam env-sync init

DESCRIPTION
  Initialize env-sync configuration

EXAMPLES
  $ okam env-sync init

See code: src/commands/env-sync/init.ts

okam env-sync list

List all configured env-sync entries

USAGE
  $ okam env-sync list

DESCRIPTION
  List all configured env-sync entries

EXAMPLES
  $ okam env-sync list

See code: src/commands/env-sync/list.ts

okam env-sync login

Login to Bitwarden CLI

USAGE
  $ okam env-sync login

DESCRIPTION
  Login to Bitwarden CLI

EXAMPLES
  $ okam env-sync login

See code: src/commands/env-sync/login.ts

okam env-sync pull

Pull environment variables from Bitwarden and save to files based on configuration

USAGE
  $ okam env-sync pull [-d <value> | -e <value>] [-s <value> | ] [-v]

FLAGS
  -d, --destination=<value>  Destination file path
  -e, --env=<value>          [default: development] Specify environment (e.g., development, production)
  -s, --source=<value>       Source Bitwarden entry name
  -v, --verbose              Enable verbose output for debugging

DESCRIPTION
  Pull environment variables from Bitwarden and save to files based on configuration

EXAMPLES
  $ okam env-sync pull

  $ okam env-sync pull --env production

See code: src/commands/env-sync/pull.ts

okam env-sync push [FILE]

Push .env file contents to Bitwarden

USAGE
  $ okam env-sync push [FILE] [-d]

ARGUMENTS
  FILE  File to push (optional)

FLAGS
  -d, --dry-run  Simulate the push operation without making changes

DESCRIPTION
  Push .env file contents to Bitwarden

EXAMPLES
  $ okam env-sync push

  $ okam env-sync push --dry-run

See code: src/commands/env-sync/push.ts

okam help [COMMAND]

Display help for okam.

USAGE
  $ okam help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for okam.

See code: @oclif/plugin-help

okam plugins

List installed plugins.

USAGE
  $ okam plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ okam plugins

See code: @oclif/plugin-plugins

okam plugins add PLUGIN

Installs a plugin into okam.

USAGE
  $ okam plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into okam.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the OKAM_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the OKAM_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ okam plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ okam plugins add myplugin

  Install a plugin from a github url.

    $ okam plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ okam plugins add someuser/someplugin

okam plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ okam plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ okam plugins inspect myplugin

See code: @oclif/plugin-plugins

okam plugins install PLUGIN

Installs a plugin into okam.

USAGE
  $ okam plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into okam.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the OKAM_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the OKAM_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ okam plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ okam plugins install myplugin

  Install a plugin from a github url.

    $ okam plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ okam plugins install someuser/someplugin

See code: @oclif/plugin-plugins

Links a plugin into the CLI for development.

USAGE
  $ okam plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ okam plugins link myplugin

See code: @oclif/plugin-plugins

okam plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ okam plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ okam plugins unlink
  $ okam plugins remove

EXAMPLES
  $ okam plugins remove myplugin

okam plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ okam plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

okam plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ okam plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ okam plugins unlink
  $ okam plugins remove

EXAMPLES
  $ okam plugins uninstall myplugin

See code: @oclif/plugin-plugins

Removes a plugin from the CLI.

USAGE
  $ okam plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ okam plugins unlink
  $ okam plugins remove

EXAMPLES
  $ okam plugins unlink myplugin

okam plugins update

Update installed plugins.

USAGE
  $ okam plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

Keywords

FAQs

Package last updated on 10 Sep 2024

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