# @kud/wifi-tool-cli

> A CLI tool to manage and view WiFi state on macOS, offering functionalities like starting/stopping WiFi and listing available SSIDs.

Latest version **1.1.1** (published 2023-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @kud/wifi-tool-cli
pnpm add @kud/wifi-tool-cli
yarn add @kud/wifi-tool-cli
bun add @kud/wifi-tool-cli
```

Provides the command `wifi-tool`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2023-10-10 |
| First published | 2023-09-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Erwann Mest |
| Maintainers | kud |

## Links

- npm: https://www.npmjs.com/package/@kud/wifi-tool-cli
- npm.io page: https://npm.io/package/@kud/wifi-tool-cli

## Dependencies (4)

- [zx](https://npm.io/package/zx.md) 7.2.3
- [ora](https://npm.io/package/ora.md) 7.0.1
- [chalk](https://npm.io/package/chalk.md) 5.3.0
- [yargs](https://npm.io/package/yargs.md) 17.7.2

## Recent versions

- 1.1.1 (latest) — 2023-10-10
- 1.1.0 — 2023-10-10
- 1.0.1-0 — 2023-09-24
- 1.0.0 — 2023-09-24

## README

# 📡 WiFi Tool

A simple command line tool to manage your WiFi settings on macOS.

## Table of Contents

1. [Features](#features)
2. [Installation](#installation)
3. [Usage](#usage)
4. [Support](#support)
5. [License](#license)

## Features

- **Start**, **Stop**, or **Restart** your WiFi with ease.
- **List** available SSIDs around you. (Note: doesn't work when sharing is ON).
- **Info**: Display the current network's information.

## Installation

Make sure you have Node.js installed. If not, download it from the [Node.js official website](https://nodejs.org/).

Then, install the tool globally:

```bash
$ npm install -g wifi-tool
```

## Usage

Use the following commands:

```bash
# To start the WiFi
$ wifi-tool start

# To stop the WiFi
$ wifi-tool stop

# To restart the WiFi
$ wifi-tool restart

# To list SSIDs
$ wifi-tool list

# To get info about the current network
$ wifi-tool info
```

For more options:

```bash
$ wifi-tool --help
```

## Support

For more information, check out the documentation or open an issue [here](https://github.com/kud/wifi-tool-cli).

## License

This project is licensed under the MIT License.

---
_Source: https://npm.io/package/@kud/wifi-tool-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
