# teetools-plugin

> A collection of sf tools some people may find useful.

Latest version **1.1.0** (published 2024-04-01) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install teetools-plugin
pnpm add teetools-plugin
yarn add teetools-plugin
bun add teetools-plugin
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2024-04-01 |
| First published | 2023-11-05 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16.0.0 |
| Dependencies | 5 |
| Unpacked size | 53 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | tbrundige |
| Maintainers | tbrundige |
| Keywords | force, salesforce, sfdx, salesforcedx, sfdx-plugin, sf-plugin, sf |

## Links

- npm: https://www.npmjs.com/package/teetools-plugin
- npm.io page: https://npm.io/package/teetools-plugin

## Dependencies (5)

- [tslib](https://npm.io/package/tslib.md) ^2
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^2.11.8
- [@salesforce/kit](https://npm.io/package/@salesforce/kit.md) ^3.1.0
- [@salesforce/core](https://npm.io/package/@salesforce/core.md) ^5.2.10
- [@salesforce/sf-plugins-core](https://npm.io/package/@salesforce/sf-plugins-core.md) ^3.1.28

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2024-04-01
- 1.0.0 — 2023-11-19
- 0.0.2 — 2023-11-05
- 0.0.1 — 2023-11-05

## README

# teetools-plugin

[![NPM](https://img.shields.io/npm/v/teetools-plugin.svg?label=teetools-plugin)](https://www.npmjs.com/package/teetools-plugin) [![Downloads/week](https://img.shields.io/npm/dw/teetools-plugin.svg)](https://npmjs.org/package/teetools-plugin) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/teetools-plugin/main/LICENSE.txt)

## Install

```bash
sf plugins install teetools-plugin@x.y.z
```

## Issues

Please report any issues at https://github.com/tbrundige/teetools-plugin/issues

## Contributing

1. Create a new issue before starting your project so that we can keep track of
   what you are trying to add/fix. That way, we can also offer suggestions or
   let you know if there is already an effort in progress.
2. Fork this repository.
3. [Build the plugin locally](#build)
4. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
5. Edit the code in your fork.
6. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
7. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

### Build

To build the plugin locally, make sure to have yarn installed and run the following commands:

```bash
# Clone the repository
git clone git@github.com:salesforcecli/teetools-plugin

# Install the dependencies and compile
yarn && yarn build
```

To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.

```bash
# Run using local run file.
./bin/dev org display info
```

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

```bash
# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins
```

## Commands

<!-- commands -->

- [`sf org display info`](#sf-org-display-info)

## `sf org display info`

Display helpful info about an org.

```
USAGE
  $ sf org display info -o <value> [--json] [-a <value>]

FLAGS
  -o, --target-org=<value>  [default: N/A] The org you would like to get information about.
  -a, --api-version=<value>  [default: N/A] The API version you would like to target.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Display helpful info about an org.

EXAMPLES
  See basic info about an org:

    $ sf org display info -o test@example.com

```

<!-- commandsstop -->

---
_Source: https://npm.io/package/teetools-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._