Skip to content
generated from pforret/bashew

Actively submit new URLs to Bing/Google via IndexNow protocol

License

Notifications You must be signed in to change notification settings

pforret/indexnow

Repository files navigation

bash_unit CI Shellcheck CI GH Language GH stars GH tag GH License basher install

pforret/indexnow

submit URLs to search engine with IndexNow protocol

🔥 Usage

Program : indexnow  by [email protected]
Version : v1.0.0 (Sep 15 19:06:37 2024)
Purpose : submit URLs to search engine with IndexNow protocol
Usage   : indexnow [-h] [-Q] [-V] [-f] [-A <API>] [-K <KEY>] [-L <LOG_DIR>] [-T <TMP_DIR>] <action> <input?>
Flags, options and parameters:
    -h|--help        : [flag] show usage [default: off]
    -Q|--QUIET       : [flag] no output [default: off]
    -V|--VERBOSE     : [flag] also show debug messages [default: off]
    -f|--FORCE       : [flag] do not ask for confirmation (always yes) [default: off]
    -A|--API <?>     : [option] API endpoint  [default: https://api.indexnow.org/IndexNow]
    -K|--KEY <?>     : [option] API key for IndexNow - get one on https://www.bing.com/indexnow/getstarted
    -L|--LOG_DIR <?> : [option] folder for log files   [default: /Users/pforret/log/indexnow]
    -T|--TMP_DIR <?> : [option] folder for temp files  [default: .tmp]
    <action>         : [choice] action to perform  [options: sitemap,url,key,check,env,update]
    <input>          : [parameter] input url (1 page or sitemap) (optional)
                                  
### TIPS & EXAMPLES
* use indexnow sitemap <url> to submit all URLs in a sitemap to Bing/Google
  indexnow sitemap https://example.com/sitemap.xml
* use indexnow url <url> to submit 1 URL to Bing/Google
  indexnow url https://example.com/news/page100/
* use indexnow key <url> to check the key file
  indexnow -K AZ102512655155PMDGHERY4225865 key https://example.com
* use indexnow check to check if this script is ready to execute and what values the options/flags are
  indexnow check
* use indexnow env to generate an example .env file
  indexnow env > .env
* use indexnow update to update to the latest version
  indexnow update
* >>> bash script created with pforret/bashew
* >>> for bash development, also check out pforret/setver and pforret/progressbar```

## ⚡️ Examples

```bash
> indexnow -h 
# get extended usage info
> indexnow env > .env
# create a .env file with default values

🚀 Installation

with basher

$ basher install pforret/indexnow

or with git

$ git clone https://github.com/pforret/indexnow.git
$ cd indexnow

📝 Acknowledgements

© 2024 Peter Forret