New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details → →

Book a Demo Sign in

@sdairs/tinybird-cli

Package Overview

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@sdairs/tinybird-cli

Experimental CLI for Tinybird

latest

Source

npm

Version: 0.1.4

Version published: last year

Maintainers: 0

Created: last year

Source

@sdairs/tinybird-cli

Experimental CLI for Tinybird

Usage

$ npm install -g @sdairs/tinybird-cli
$ tinybird-cli COMMAND
running command...
$ tinybird-cli (--version)
@sdairs/tinybird-cli/0.1.4 darwin-arm64 node-v22.11.0
$ tinybird-cli --help [COMMAND]
USAGE
  $ tinybird-cli COMMAND
...

Commands

`tinybird-cli auth`

Authenticate with your Tinybird workspace

USAGE
  $ tinybird-cli auth [-t <value>] [-d <value>]

FLAGS
  -d, --dir=<value>    Path to Tinybird project directory
  -t, --token=<value>  Tinybird API token

DESCRIPTION
  Authenticate with your Tinybird workspace

EXAMPLES
  $ tinybird-cli auth

  $ tinybird-cli auth --token your-token

  $ tinybird-cli auth --dir /path/to/project

See code: src/commands/auth/index.ts

`tinybird-cli create TYPE NAME`

Create a new Tinybird resource file

USAGE
  $ tinybird-cli create TYPE NAME [-d <value>]

ARGUMENTS
  TYPE  (datasource|query|connection|secret|variable) Type of resource to create
  NAME  Name of the resource

FLAGS
  -d, --dir=<value>  Path to Tinybird project directory

DESCRIPTION
  Create a new Tinybird resource file

EXAMPLES
  $ tinybird-cli create datasource my_ds

  $ tinybird-cli create query my_query

  $ tinybird-cli create connection my_kafka

  $ tinybird-cli create secret my_secret

  $ tinybird-cli create variable my_var

  $ tinybird-cli create datasource my_ds --dir /path/to/project

See code: src/commands/create/index.ts

`tinybird-cli docs`

Generate and serve documentation from .tinybird files

USAGE
  $ tinybird-cli docs [-d <value>]

FLAGS
  -d, --dir=<value>  [default: ./tinybird] Path to the tinybird directory

DESCRIPTION
  Generate and serve documentation from .tinybird files

EXAMPLES
  $ tinybird-cli docs

  $ tinybird-cli docs --dir /path/to/tinybird

See code: src/commands/docs/index.ts

`tinybird-cli help [COMMAND]`

Display help for tinybird-cli.

USAGE
  $ tinybird-cli 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 tinybird-cli.

See code: @oclif/plugin-help

`tinybird-cli init`

Initialize a new Tinybird project structure

USAGE
  $ tinybird-cli init [-d <value>]

FLAGS
  -d, --dir=<value>  [default: .] Parent directory for the tinybird project

DESCRIPTION
  Initialize a new Tinybird project structure

EXAMPLES
  $ tinybird-cli init

  $ tinybird-cli init --dir my-project

See code: src/commands/init/index.ts

`tinybird-cli plugins`

List installed plugins.

USAGE
  $ tinybird-cli plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ tinybird-cli plugins

See code: @oclif/plugin-plugins

`tinybird-cli plugins:add PLUGIN`

Installs a plugin into tinybird-cli.

USAGE
  $ tinybird-cli 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 tinybird-cli.

  Uses npm to install plugins.

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

  Use the TINYBIRD_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the TINYBIRD_CLI_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ tinybird-cli plugins:add

EXAMPLES
  Install a plugin from npm registry.

    $ tinybird-cli plugins:add myplugin

  Install a plugin from a github url.

    $ tinybird-cli plugins:add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ tinybird-cli plugins:add someuser/someplugin

`tinybird-cli plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

USAGE
  $ tinybird-cli 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
  $ tinybird-cli plugins:inspect myplugin

See code: @oclif/plugin-plugins

`tinybird-cli plugins:install PLUGIN`

Installs a plugin into tinybird-cli.

USAGE
  $ tinybird-cli 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 tinybird-cli.

  Uses npm to install plugins.

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

  Use the TINYBIRD_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the TINYBIRD_CLI_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ tinybird-cli plugins:add

EXAMPLES
  Install a plugin from npm registry.

    $ tinybird-cli plugins:install myplugin

  Install a plugin from a github url.

    $ tinybird-cli plugins:install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ tinybird-cli plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

`tinybird-cli plugins:link PATH`

Links a plugin into the CLI for development.

USAGE
  $ tinybird-cli 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
  $ tinybird-cli plugins:link myplugin

See code: @oclif/plugin-plugins

`tinybird-cli plugins:remove [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ tinybird-cli 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
  $ tinybird-cli plugins:unlink
  $ tinybird-cli plugins:remove

EXAMPLES
  $ tinybird-cli plugins:remove myplugin

`tinybird-cli plugins:reset`

Remove all user-installed and linked plugins.

USAGE
  $ tinybird-cli 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

`tinybird-cli plugins:uninstall [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ tinybird-cli 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
  $ tinybird-cli plugins:unlink
  $ tinybird-cli plugins:remove

EXAMPLES
  $ tinybird-cli plugins:uninstall myplugin

See code: @oclif/plugin-plugins

`tinybird-cli plugins:unlink [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ tinybird-cli 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
  $ tinybird-cli plugins:unlink
  $ tinybird-cli plugins:remove

EXAMPLES
  $ tinybird-cli plugins:unlink myplugin

`tinybird-cli plugins:update`

Update installed plugins.

USAGE
  $ tinybird-cli plugins:update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

Keywords

oclif

FAQs

What is @sdairs/tinybird-cli?

Is @sdairs/tinybird-cli well maintained?

Package last updated on 07 Dec 2024

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.

Install

@sdairs/tinybird-cli

@sdairs/tinybird-cli

Usage

Commands

tinybird-cli auth

tinybird-cli create TYPE NAME

tinybird-cli docs

tinybird-cli help [COMMAND]

tinybird-cli init

tinybird-cli plugins

tinybird-cli plugins:add PLUGIN

tinybird-cli plugins:inspect PLUGIN...

tinybird-cli plugins:install PLUGIN

tinybird-cli plugins:link PATH

tinybird-cli plugins:remove [PLUGIN]

tinybird-cli plugins:reset

tinybird-cli plugins:uninstall [PLUGIN]

tinybird-cli plugins:unlink [PLUGIN]

tinybird-cli plugins:update

Keywords

Related posts

Axios Maintainer Confirms Social Engineering Attack Behind npm Compromise

Node.js Drops Bug Bounty Rewards After Funding Dries Up

`tinybird-cli auth`

`tinybird-cli create TYPE NAME`

`tinybird-cli docs`

`tinybird-cli help [COMMAND]`

`tinybird-cli init`

`tinybird-cli plugins`

`tinybird-cli plugins:add PLUGIN`

`tinybird-cli plugins:inspect PLUGIN...`

`tinybird-cli plugins:install PLUGIN`

`tinybird-cli plugins:link PATH`

`tinybird-cli plugins:remove [PLUGIN]`

`tinybird-cli plugins:reset`

`tinybird-cli plugins:uninstall [PLUGIN]`

`tinybird-cli plugins:unlink [PLUGIN]`

`tinybird-cli plugins:update`