Skip to content

configure

Save your API key locally so you don't have to pass it every time.

bash
avg configure --key avg_xxxxxxxxxxxxxxxxxxxx
avg configure --show   # print current config
FlagDescription
-k, --key <key>Your developer API key
--api-url <url>Custom API base URL
--showPrint the current saved configuration

profiles list

List all birth profiles on your account.

bash
avg profiles list

profiles create

Create a new birth profile.

bash
avg profiles create \
  -n "Arjun Sharma" \
  -g male \
  -d 1990-06-15 \
  -t 06:30 \
  -z Asia/Kathmandu \
  -l "Kathmandu, Nepal" \
  --lat 27.7172 --lon 85.3240
FlagDescription
-n, --name <name>Full name
-g, --gender <gender>male or female
-d, --date <date>Birth date YYYY-MM-DD (AD/Gregorian)
-t, --time <time>Birth time HH:mm (24-hour)
-z, --timezone <tz>IANA timezone, e.g. Asia/Kathmandu
-l, --location <loc>Location name (for display)
--lat <lat>Latitude (decimal degrees)
--lon <lon>Longitude (decimal degrees)
--notes <notes>Optional notes

chart full

Full birth chart — planets, houses, and ascendant.

bash
avg chart full <profileId>
avg chart full <profileId> --json   # raw JSON output

chart details

Key details — ascendant, moon sign, sun sign, nakshatra.

bash
avg chart details <profileId>

rashifal

Horoscope forecast for any period.

bash
avg rashifal <profileId>
avg rashifal <profileId> --period monthly --calendar bs
avg rashifal <profileId> --period daily --locale ne
FlagDescription
-p, --period <period>daily · weekly · monthly · yearly (default: monthly)
-c, --calendar <cal>ad (Gregorian) · bs (Bikram Sambat, default: ad)
-l, --locale <locale>en · hi · ne (default: en)
--jsonRaw JSON output

keys list

Show all API keys and current credit balance.

bash
avg keys list

keys create

Create a new API key. The full key is shown once — save it immediately.

bash
avg keys create "My App"

keys revoke

Permanently revoke an API key.

bash
avg keys revoke <keyId>

Global flags

FlagDescription
--jsonOutput raw JSON (supported on most read commands)
--versionPrint CLI version
--helpShow help for any command

JSON output

All read commands accept --json for scripting:

bash
# Extract all planet signs with jq
avg chart full <profileId> --json | jq '[.planets[] | {planet, sign, house}]'

# Get current rashifal score
avg rashifal <profileId> --json | jq '.overallScore'