https://github.com/douxxu/2pme-cli
A CLI tool to interact with the 2PeekMe API
https://github.com/douxxu/2pme-cli
2peekme cli free subdomains
Last synced: 6 months ago
JSON representation
A CLI tool to interact with the 2PeekMe API
- Host: GitHub
- URL: https://github.com/douxxu/2pme-cli
- Owner: douxxu
- License: gpl-3.0
- Created: 2024-12-13T21:39:11.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-01-05T20:44:45.000Z (9 months ago)
- Last Synced: 2025-01-05T21:28:29.580Z (9 months ago)
- Topics: 2peekme, cli, free, subdomains
- Language: JavaScript
- Homepage: https://2peek.me
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# 2peekme CLI
A command-line interface tool for interacting with the [2PeekMe API](https://2peek.me). This CLI allows you to manage subdomains, DNS records, and your API key easily from your terminal.
>More documentaiton can be found here: [https://2peek.me](https://2peek.me)
## Installation
To install the 2peekme CLI globally, run the following command:
```bash
npm i -g 2pme
```
## Usage
After installation, you can use the CLI with the following command:
```bash
2pme [command]
```
## Commands
Here are some of the available commands:
- `key` - Manage your API key.
- Options:
- `--create` - Generate a new API key.
- `--set ` - Set your API key.
- `--info` - Get information about your API key.
- `--delete` - Delete your current API key.
- `create` - Create a new subdomain.
- Options:
- `--name ` - Subdomain name.
- `--type ` - DNS record type (A, CNAME, TXT, etc.).
- `--value ` - Record value.
- `update` - Update an existing subdomain.
- Options:
- `--name ` - Subdomain name.
- `--type ` - New DNS record type.
- `--value ` - New record value.
- `delete` - Delete a subdomain.
- Options:
- `--name ` - Subdomain name.
- `list` - List all subdomains.
## License
This project is licensed under the GPL-3.0 License.