Pipeable OADA client CLI
This largely grew from my playground for experimenting with newish (or new to me at least) Node and TypeScript stuff. As such it requires Node 15, and has no actual tests yet. The code could use a major refactor, but it useful and working for me at least. I mostly put it here for my own safe-keeping. It is not particularly fast or efficient.
It has help output that is rather terse for now.
It supports various JSON-y input formats:
It can get inputs from local files, paths in OADA APIs, or generic URLs to JSON. Also it can take Concatenated JSON piped through standard input.
It will currently die a horrible death if you try to use it with any other non-JSON data.
It outputs JSONL (or pretty-printed Concatenated JSON in TTY mode).
This makes piping with traditional line-based CLI tools easy.
Also it is very useful with tools like jq.
There is support for configuring it for multiple OADA APIs and moving files between them.
It supports "shell expansion" of a sort via minimatch
(i.e., you can use paths like /bookmarks/trellis/*/test{s,y}/
and they will be expanded).
$ npm install -g clioada
$ oada COMMAND
running command...
$ oada (-v|--version|version)
clioada/1.0.0 linux-x64 node-v15.6.0
$ oada --help [COMMAND]
USAGE
$ oada COMMAND
...
oada autocomplete [SHELL]oada config:showoada delete PATHS...oada fs:copy PATHS... PATHoada fs:link PATHS... PATHoada fs:list PATHS...oada fs:move PATHS... PATHoada fs:remove PATHS...oada get PATHS...oada head PATHS...oada help [COMMAND]oada pluginsoada plugins:install PLUGIN...oada plugins:link PLUGINoada plugins:uninstall PLUGIN...oada plugins:updateoada post PATHS... PATHoada put PATHS... PATHoada autocomplete [SHELL]display autocomplete installation instructions
USAGE
$ oada autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ oada autocomplete
$ oada autocomplete bash
$ oada autocomplete zsh
$ oada autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
oada config:showShow the current config settings
USAGE
$ oada config:show
OPTIONS
-d, --domain=domain [default: localhost] default OADA API domain
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada config
See code: src/commands/config/show.ts
oada delete PATHS...perform an OADA DELETE
USAGE
$ oada delete PATHS...
ARGUMENTS
PATHS... OADA path(s) to GET
OPTIONS
-R, --recursive
-d, --domain=domain [default: localhost] default OADA API domain
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada d
$ oada rm
$ oada DELETE
See code: src/commands/delete.ts
oada fs:copy PATHS... PATHperform an "OADA copy"
USAGE
$ oada fs:copy PATHS... PATH
ARGUMENTS
PATHS... path(s) to copy
PATH OADA path to which to copy
OPTIONS
-d, --domain=domain [default: localhost] default OADA API domain
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada cp
See code: src/commands/fs/copy.ts
oada fs:link PATHS... PATHperform an "OADA link"
USAGE
$ oada fs:link PATHS... PATH
ARGUMENTS
PATHS... path(s) to link
PATH OADA path in which to link
OPTIONS
-d, --domain=domain [default: localhost] default OADA API domain
-f, --force delete conflicting existing data/links
-r, --versioned make versioned link(s)
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada ln
See code: src/commands/fs/link.ts
oada fs:list PATHS...perform an "OADA ls"
USAGE
$ oada fs:list PATHS...
ARGUMENTS
PATHS... path(s) to list
OPTIONS
-d, --domain=domain [default: localhost] default OADA API domain
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada ls
$ oada l
See code: src/commands/fs/list.ts
oada fs:move PATHS... PATHperform an "OADA move"
USAGE
$ oada fs:move PATHS... PATH
ARGUMENTS
PATHS... path(s) to move
PATH OADA path to which to move
OPTIONS
-d, --domain=domain [default: localhost] default OADA API domain
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada mv
See code: src/commands/fs/move.ts
oada fs:remove PATHS...perform an OADA DELETE
USAGE
$ oada fs:remove PATHS...
ARGUMENTS
PATHS... OADA path(s) to GET
OPTIONS
-R, --recursive
-d, --domain=domain [default: localhost] default OADA API domain
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada d
$ oada rm
$ oada DELETE
See code: src/commands/fs/remove.ts
oada get PATHS...perform an OADA GET (read)
USAGE
$ oada get PATHS...
ARGUMENTS
PATHS... OADA path(s) to GET
OPTIONS
-R, --recursive
-d, --domain=domain [default: localhost] default OADA API domain
-m, --meta
-o, --out=out [default: -]
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada g
$ oada GET
EXAMPLE
$ oada get /bookmark
{
"_id": "resources/default:resources_bookmarks_321",
"_rev": 45,
"_type": "application/vnd.oada.bookmarks.1+json",
"_meta": {
"_id": "resources/default:resources_bookmarks_321/_meta",
"_rev": 45
}
}
See code: src/commands/get.ts
oada head PATHS...perform an OADA HEAD
USAGE
$ oada head PATHS...
ARGUMENTS
PATHS... OADA path(s) to HEAD
OPTIONS
-d, --domain=domain [default: localhost] default OADA API domain
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada h
$ oada HEAD
See code: src/commands/head.ts
oada help [COMMAND]display help for oada
USAGE
$ oada help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
oada pluginslist installed plugins
USAGE
$ oada plugins
OPTIONS
--core show core plugins
EXAMPLE
$ oada plugins
See code: @oclif/plugin-plugins
oada plugins:install PLUGIN...installs a plugin into the CLI
USAGE
$ oada plugins:install PLUGIN...
ARGUMENTS
PLUGIN plugin to install
OPTIONS
-f, --force yarn install with force flag
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ oada plugins:add
EXAMPLES
$ oada plugins:install myplugin
$ oada plugins:install https://github.com/someuser/someplugin
$ oada plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
oada plugins:link PLUGINlinks a plugin into the CLI for development
USAGE
$ oada plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help show CLI help
-v, --verbose
DESCRIPTION
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.
EXAMPLE
$ oada plugins:link myplugin
See code: @oclif/plugin-plugins
oada plugins:uninstall PLUGIN...removes a plugin from the CLI
USAGE
$ oada plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help show CLI help
-v, --verbose
ALIASES
$ oada plugins:unlink
$ oada plugins:remove
See code: @oclif/plugin-plugins
oada plugins:updateupdate installed plugins
USAGE
$ oada plugins:update
OPTIONS
-h, --help show CLI help
-v, --verbose
See code: @oclif/plugin-plugins
oada post PATHS... PATHPerform an OADA POST
USAGE
$ oada post PATHS... PATH
ARGUMENTS
PATHS... paths to POST
PATH destination OADA path
OPTIONS
-R, --recursive
-d, --domain=domain [default: localhost] default OADA API domain
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada po
$ oada POST
See code: src/commands/post.ts
oada put PATHS... PATHPerform an OADA PUT
USAGE
$ oada put PATHS... PATH
ARGUMENTS
PATHS... paths to PUT
PATH destination OADA path
OPTIONS
-R, --recursive
-d, --domain=domain [default: localhost] default OADA API domain
-t, --token=token default OADA API token
--[no-]tty format output for TTY
--[no-]ws use WebSockets for OADA API
ALIASES
$ oada pu
$ oada PUT
See code: src/commands/put.ts
FAQs
CLI OADA
The npm package clioada receives a total of 11 weekly downloads. As such, clioada popularity was classified as not popular.
We found that clioada demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.