Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/turbot/steampipe-plugin-namecheap

Use SQL to instantly query Namecheap for domains, DNS host records & more. Open source CLI. No DB required.
https://github.com/turbot/steampipe-plugin-namecheap

backup domains etl hacktoberfest namecheap postgresql postgresql-fdw sql sqlite steampipe steampipe-plugin zero-etl

Last synced: 8 days ago
JSON representation

Use SQL to instantly query Namecheap for domains, DNS host records & more. Open source CLI. No DB required.

Awesome Lists containing this project

README 

        
![image](https://hub.steampipe.io/images/plugins/turbot/namecheap-social-graphic.png)



# Namecheap Plugin for Steampipe



Use SQL to query models, completions and more from Namecheap.



- **[Get started →](https://hub.steampipe.io/plugins/turbot/namecheap)**

- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/turbot/namecheap/tables)

- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)

- Get involved: [Issues](https://github.com/turbot/steampipe-plugin-namecheap/issues)



## Quick start



### Install



Download and install the latest Namecheap plugin:



```bash

steampipe plugin install namecheap

```



Configure your [credentials](https://hub.steampipe.io/plugins/turbot/namecheap#credentials) and [config file](https://hub.steampipe.io/plugins/turbot/namecheap#configuration).



Configure your account details in `~/.steampipe/config/namecheap.spc`:



```hcl

connection "namecheap" {

  plugin = "namecheap"



  # Authentication information

  username  = "janedoe"

  api_key   = "33d0d62a6a163083ba7b3bab31bd6612"

}

```



Or through environment variables:



```sh

export NAMECHEAP_USERNAME=janedoe

export NAMECHEAP_API_KEY=33d0d62a6a163083ba7b3bab31bd6612

```



Run steampipe:



```shell

steampipe query

```



List domains in your Namecheap account:



```sql

select

  domain,

  expires

from

  namecheap_domain

order by

  domain;

```



```

+--------------+---------------------------+

| domain       | expires                   |

+--------------+---------------------------+

| steampipe.io | 2025-04-19T20:00:00-04:00 |

| turbot.com   | 2024-03-07T20:00:00-04:00 |

+--------------+---------------------------+

```



## Engines



This plugin is available for the following engines:



| Engine        | Description

|---------------|------------------------------------------

| [Steampipe](https://steampipe.io/docs) | The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.

| [Postgres FDW](https://steampipe.io/docs/steampipe_postgres/overview) | Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.

| [SQLite Extension](https://steampipe.io/docs/steampipe_sqlite/overview) | Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.

| [Export](https://steampipe.io/docs/steampipe_export/overview) | Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.

| [Turbot Pipes](https://turbot.com/pipes/docs) | Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.



## Developing



Prerequisites:



- [Steampipe](https://steampipe.io/downloads)

- [Golang](https://golang.org/doc/install)



Clone:



```sh

git clone https://github.com/turbot/steampipe-plugin-namecheap.git

cd steampipe-plugin-namecheap

```



Build, which automatically installs the new version to your `~/.steampipe/plugins` directory:



```

make

```



Configure the plugin:



```

cp config/* ~/.steampipe/config

vi ~/.steampipe/config/namecheap.spc

```



Try it!



```

steampipe query

> .inspect namecheap

```



Further reading:



- [Writing plugins](https://steampipe.io/docs/develop/writing-plugins)

- [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)



## Open Source & Contributing



This repository is published under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) (source code) and [CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/2.0/) (docs) licenses. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!



[Steampipe](https://steampipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).



## Get Involved



**[Join #steampipe on Slack →](https://turbot.com/community/join)**



Want to help but don't know where to start? Pick up one of the `help wanted` issues:



- [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)

- [Namecheap Plugin](https://github.com/turbot/steampipe-plugin-namecheap/labels/help%20wanted)