nf - Nutrition Facts CLI

A command-line tool to get macronutrient information for any food using the USDA FoodData Central API.

Installation

Prerequisites

• Node.js (v12 or higher)
• A free USDA FoodData Central API key

Github Install

# Clone the repository
git clone https://github.com/NikoStapczynski/nutrition-facts.git
cd nutrition-facts

# Make the script executable
chmod +x nf

# Move to your PATH (choose one)
sudo mv nf /usr/local/bin/nf
# OR for user-only install:
mkdir -p ~/.local/bin
mv nf ~/.local/bin/nf

USDA FoodData Central API Key

1. Request an API key here: https://fdc.nal.usda.gov/api-key-signup.html
2. Copy your API key from an email from noreply@api.data.gov titled "Your API key"
3. Configure nf: nf --setup YOUR_API_KEY_HERE

Usage

# Single food defaults to 1 serving
nf apple
# 1 apple APPLE: 52 calories, 0g protein, 14g carbs, 1g fat

# Multiple foods should be comma seperated
nf chicken breast, rice, broccoli
# Chicken Breast: 165 calories, 31g protein, 0g carbs, 3.6g fat
# Rice: 130 calories, 2.7g protein, 28g carbs, 0.3g fat
# Broccoli: 55 calories, 3.7g protein, 11g carbs, 0.6g fat
# ---
# Total: 350 calories, 37.4g protein, 39g carbs, 4.5g fat

# Foods with quantities and units
nf 1 lb ground beef, 1 gal milk, 500 eggs
# 1 lb GROUND BEEF: 1415 calories, 77g protein, 0g carbs, 122g fat
# 1 gal MILK: 2082 calories, 128g protein, 192g carbs, 80g fat
# 500 eggs EGGS: 142750 calories, 893g protein, 14275g carbs, 8925g fat
# ---
# Total: 146247 calories, 1098g protein, 14467g carbs, 9127g fat

# Mixed formats
nf apple, 200g chicken breast, 1 cup rice
# Apples, raw, with skin: 52 calories, 0g protein, 14g carbs, 0g fat
# 200g Chicken, broilers or fryers, breast, meat only, cooked, roasted: 331 calories, 62g protein, 0g carbs, 7g fat
# 1 cup Rice, white, long grain, regular, cooked: 205 calories, 4.3g protein, 44g carbs, 0.4g fat
# ---
# Total: 588 calories, 66.3g protein, 58g carbs, 7.4g fat

# View help
nf --help
# nf - Nutrition Facts CLI Tool
#
# USAGE:
#   nf <quantity> <unit> <food_item>[, <quantity> <unit> <food_item2>, ...]
#   nf <food_item> [food_item2] [food_item3] ...  (assumes 1 serving each)
#   nf --setup <api_key>
#   nf --help
#
# EXAMPLES:
#   nf apple
#   nf "chicken breast" rice broccoli
#   nf 1 lb ground beef, 1 gal milk, 500 eggs
#   nf 200g chicken breast, 1 cup rice
#   nf --setup YOUR_API_KEY_HERE

Supported Units

• Weight: g, lb, oz, kg
• Volume: cup, tbsp, tsp, ml, l, gal, qt, pt, fl_oz
• Special: egg, eggs (50g each)

Configuration

Your API key is stored in ~/.config/nf/config.json

To reconfigure:

nf --setup NEW_API_KEY

License

GPL-3.0 License - see LICENSE file for details

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Author

Niko Stapczynski

Acknowledgments

• Nutrition data provided by USDA FoodData Central