- Introduction
- ⚡ Quick Start
- Key Features
- 📖 Usage and Documentation
- 🎯 Common Use Cases
- 💎 Modules
- 📚 API Reference
- 🌍 Supported Locales
- Consuming the library with CMake
- Installing the library with vcpkg
- ⚒️ Compiler support
- Dependencies
- 📦 Building the library with Conan
- Installing the library with Conan
- Building the library with Bazel
- ✨ Contributing
- 📘 Credits
- 📝 Changelog
- 🔑 License
Faker C++ is a C++ library inspired by the popular Faker.js, aimed at providing developers with a robust tool for generating fake (but realistic) data. Whether you're building test suites, populating databases, or creating demos, Faker C++ has got you covered.
Want to get started immediately? Check out our Quick Start Guide for a 5-minute introduction!
#include <iostream>
#include "faker-cxx/faker.h"
int main() {
std::cout << faker::person::fullName() << std::endl; // "Jennifer Martin"
std::cout << faker::internet::email() << std::endl; // "martin.jennifer@gmail.com"
std::cout << faker::location::city() << std::endl; // "Los Angeles"
std::cout << faker::string::uuidV4() << std::endl; // "8e3a4f21-5c7b-4d9a-8f2e-1b9c7d6a5e3f"
return 0;
}
👉 Read the Quick Start Guide for installation and more examples!
📚 Realistic Data Generation: Generate various types of data including names, addresses, emails, dates, and more.
🛠 Modular Design: Choose from a wide range of modules like Internet, Location, String, Date, and more to generate specific types of data.
🚀 Easy Integration: Seamlessly integrate with CMake, and it supports major compilers like MSVC, GCC, Clang, and Apple Clang.
To properly use Faker C++ you must first consume the Faker library (see Consuming Library with CMake).
Once that is done, you need to include the proper header file
depending on the module you wish to generate data from or use general include file faker-cxx/faker.h.
All the documentation can be found at cieslarmichal.github.io/faker-cxx.
Below is an example of how to use Faker C++ in your code.
#include <iostream>
#include "faker-cxx/faker.h" // or include specific module
int main()
{
const auto id = faker::string::uuidV4();
const auto email = faker::internet::email();
const auto password = faker::internet::password();
const auto city = faker::location::city();
const auto streetAddress = faker::location::streetAddress();
const auto bornDate = faker::date::birthdateByYear(1970, 2000);
std::cout << id << std::endl; // 59990db5-3a5f-40bf-8af0-7834c29ee884
std::cout << email << std::endl; // hills.rita@gmail.com
std::cout << password << std::endl; // Mf+*[(_'lHfM.$v{
std::cout << city << std::endl; // Rochester
std::cout << streetAddress << std::endl; // 643 Ricardo Creek
std::cout << bornDate << std::endl; // 1973-12-03T11:07:02Z
return 0;
}
#include "faker-cxx/faker.h"
struct User {
std::string id = faker::string::uuidV4();
std::string name = faker::person::fullName();
std::string email = faker::internet::email();
std::string address = faker::location::streetAddress();
std::string city = faker::location::city();
std::string zipCode = faker::location::zipCode();
std::string phone = faker::phone::number();
std::string birthdate = faker::date::birthdateByYear(1970, 2005);
};
struct Product {
std::string id = faker::string::uuidV4();
std::string name = faker::commerce::productFullName();
std::string price = faker::finance::amount(10, 1000, faker::Precision::TwoDp, "$");
std::string sku = faker::commerce::sku();
std::string category = faker::commerce::productCategory();
};
std::string blogTitle = faker::lorem::words(5); // Blog post title
std::string author = faker::person::fullName(); // Author name
std::string content = faker::lorem::paragraphs(3); // Article content
std::string summary = faker::lorem::sentence(); // Brief summary
auto uuid = faker::string::uuidV4(); // "8e3a4f21-5c7b-4d9a-8f2e-1b9c7d6a5e3f"
auto ulid = faker::string::ulid(); // "01ARZ3NDEKTSV4RRFFQ69G5FAV"
auto nanoid = faker::string::nanoId(); // "V1StGXR8_Z5jdHi6B-myT"
std::string iban = faker::finance::iban(); // "DE89370400440532013000"
std::string creditCard = faker::finance::creditCardNumber(); // "4532-1488-0343-6467"
std::string amount = faker::finance::amount(100, 10000, faker::Precision::TwoDp, "€");
// Generate Polish names
auto plName = faker::person::firstName(faker::Locale::pl_PL); // "Krystyna"
// Generate French addresses
auto frCity = faker::location::city(faker::Locale::fr_FR); // "Lyon"
// Generate German IBAN
auto deIban = faker::finance::iban(faker::Locale::de_DE); // "DE89370400440532013000"
- 🛩 Airline - aircraft, airlines, airports, flight numbers
- 🐼 Animal - species by type (bear, bird, cat, dog, etc.)
- 📖 Book - title, genre, author, publisher
- 🎨 Color - name, rgb, hex, hsl, lch, cmyk
- 🛒 Commerce - products, prices, SKU, EAN, ISBN
- 🏢 Company - name, type, industry, buzzwords
- 🖥️ Computer - type, manufacturer, CPU, GPU
- 🔐 Crypto - SHA, MD5 hashes
- 💾 Database - column names, types, engines
- ℹ️ Datatype - booleans
- 📅 Date - past/future dates, birthdays, weekdays
- 🕹️ E-sport - players, teams, leagues
- 🎓 Education - schools, degrees, fields of study
- 🏦 Finance - currency, IBAN, BIC, credit cards
- 🍝 Food - dishes, ingredients, beverages
- 📁 Git - branch, commit, SHA
- 👨💻 Hacker - abbreviations, phrases
- 🖼️ Image - URLs, dimensions, types
- 🌐 Internet - email, username, password, IP, URL
- 🌍 Location - country, city, address, coordinates, MGRS grid
- 📚 Lorem - words, sentences, paragraphs
- 🏥 Medicine - conditions, tests, specialties
- 🎥 Movie - titles, genres, actors, directors
- 🎶 Music - artists, songs, genres
- 🔢 Number - integers, decimals, hex, binary
- 🧑 Person - names, titles, bio, SSN
- 📞 Phone - numbers, IMEI
- 🪴 Plant - trees, flowers
- 🧑🔬 Science - chemical elements, units
- ⚽ Sport - sports, teams, athletes
- 🔢 String - UUID, ULID, Nano ID, alphanumeric
- 💻 System - file names, paths, MIME types
- 🚗 Vehicle - manufacturer, model, VIN
- 🎞️ Video - formats, codecs, resolutions
- 🎮 Video game - titles, genres, platforms
- 🌤️ Weather - descriptions
- 💬 Word - adjectives, nouns, verbs
Use Ctrl+F (Cmd+F on Mac) to search for specific functions!
💡 For detailed docs with parameters and options, see cieslarmichal.github.io/faker-cxx
faker::airline::aircraftType() // "narrowbody"
faker::airline::airplane() // {name: "Boeing 737", iataTypeCode: "737"}
faker::airline::airline() // {name: "American Airlines", iataCode: "AA"}
faker::airline::airport() // {name: "Los Angeles International Airport", iataCode: "LAX"}
faker::airline::seat(aircraftType) // "1A"
faker::airline::recordLocator() // "ABCDEF"
faker::airline::recordLocator(true) // "ABC123"
faker::airline::flightNumber() // "1234"
faker::airline::flightNumber(true) // "0123"
faker::airline::flightNumberByRange() // "234"
faker::animal::bear() // "Grizzly bear"
faker::animal::bird() // "Eagle"
faker::animal::cat() // "Siamese"
faker::animal::cetacean() // "Dolphin"
faker::animal::cow() // "Holstein"
faker::animal::crocodile() // "Nile crocodile"
faker::animal::dog() // "Golden Retriever"
faker::animal::fish() // "Salmon"
faker::animal::horse() // "Arabian"
faker::animal::insect() // "Butterfly"
faker::animal::lion() // "African Lion"
faker::animal::rabbit() // "Angora"
faker::animal::rodent() // "Hamster"
faker::animal::snake() // "Python"
faker::animal::type() // "mammal"
faker::book::title() // "The Great Gatsby"
faker::book::genre() // "Science Fiction"
faker::book::author() // "George Orwell"
faker::book::publisher() // "Penguin Books"
faker::book::format() // "Hardcover"
faker::book::series() // "Harry Potter"
faker::color::name() // "Red"
faker::color::rgb() // "rgb(255, 0, 0)"
faker::color::hex() // "#FF0000"
faker::color::hsl() // "hsl(0, 100%, 50%)"
faker::color::lch() // "lch(53.24, 104.55, 40)"
faker::color::cmyk() // "cmyk(0, 100, 100, 0)"
faker::color::lab() // "lab(53.24, 80.09, 67.20)"
faker::color::hsb() // "hsb(0, 100%, 100%)"
faker::color::hsv() // "hsv(0, 100%, 100%)"
faker::color::hwb() // "hwb(0, 0%, 0%)"
faker::color::yuv() // "yuv(127, 0, 0)"
faker::color::space() // "sRGB"
faker::commerce::department() // "Electronics"
faker::commerce::sku() // "ABC-12345"
faker::commerce::productAdjective() // "Awesome"
faker::commerce::productMaterial() // "Cotton"
faker::commerce::productName() // "Shirt"
faker::commerce::productFullName() // "Awesome Cotton Shirt"
faker::commerce::EAN13() // "1234567890123"
faker::commerce::EAN8() // "12345678"
faker::commerce::ISBN13() // "978-1-234-56789-0"
faker::commerce::ISBN10() // "1-234-56789-0"
faker::commerce::paymentType() // "Credit Card"
faker::commerce::paymentProvider() // "Visa"
faker::commerce::productDescription() // "Ergonomic and stylish!"
faker::commerce::productCategory() // "Clothing"
faker::commerce::productReview() // "Great product!"
faker::commerce::discountType() // "Percentage"
faker::commerce::orderStatus() // "Shipped"
faker::commerce::shippingCarrier() // "FedEx"
faker::company::companyName() // "Peterson Inc"
faker::company::type() // "LLC"
faker::company::industry() // "Technology"
faker::company::buzzPhrase() // "innovate cutting-edge systems"
faker::company::buzzAdjective() // "innovative"
faker::company::buzzNoun() // "synergy"
faker::company::buzzVerb() // "implement"
faker::company::catchPhrase() // "Quality-focused scalable initiative"
faker::company::catchPhraseAdjective() // "Quality-focused"
faker::company::catchPhraseDescriptor() // "scalable"
faker::company::catchPhraseNoun() // "initiative"
faker::computer::type() // "laptop"
faker::computer::manufacture() // "Dell"
faker::computer::model() // "XPS 15"
faker::computer::cpuManufacture() // "Intel"
faker::computer::cpuType() // "x64"
faker::computer::cpuModel() // "Core i7-9700K"
faker::computer::gpuManufacture() // "NVIDIA"
faker::computer::gpuType() // "Integrated"
faker::computer::gpuModel() // "GeForce GTX 1080"
faker::crypto::sha256() // "a3c4f...(64 chars)"
faker::crypto::sha1() // "4e9d8...(40 chars)"
faker::crypto::md5() // "9b3e4...(32 chars)"
faker::database::columnName() // "id"
faker::database::columnType() // "INT"
faker::database::collation() // "utf8_unicode_ci"
faker::database::engine() // "InnoDB"
faker::database::mongoDbObjectId() // "507f1f77bcf86cd799439011"
faker::datatype::boolean() // true or false
faker::datatype::boolean(0.7) // 70% chance of true
faker::date::anytime() // "2023-07-15T14:30:00Z"
faker::date::pastDate() // "2022-03-12T08:15:00Z"
faker::date::futureDate() // "2024-11-20T19:45:00Z"
faker::date::recentDate() // "2023-07-13T10:20:00Z"
faker::date::soonDate() // "2023-07-17T16:00:00Z"
faker::date::birthdateByAge(18, 65) // "1988-05-23T00:00:00Z"
faker::date::birthdateByYear(1990, 2000) // "1995-08-15T00:00:00Z"
faker::date::weekdayName() // "Monday"
faker::date::weekdayAbbreviatedName() // "Mon"
faker::date::monthName() // "January"
faker::date::monthAbbreviatedName() // "Jan"
faker::date::year() // 2000
faker::date::month() // 9
faker::date::hour() // 21
faker::date::minute() // 40
faker::date::second() // 40
faker::date::time() // "21:40"
faker::date::dayOfMonth() // 15
faker::date::dayOfWeek() // 5
faker::date::timezoneRandom() // "America/New_York"
faker::date::between(from, to) // Random date between two timestamps
faker::education::school() // "Harvard University"
faker::education::degree() // "Bachelor of Science"
faker::education::field() // "Computer Science"
faker::education::term() // "Fall Semester"
faker::education::courses() // "Data Structures"
faker::esport::player() // "Ninja"
faker::esport::team() // "Team Liquid"
faker::esport::league() // "League of Legends Championship Series"
faker::esport::event() // "The International"
faker::esport::game() // "Dota 2"
faker::esport::organizer() // "ESL"
faker::finance::currency() // {name: "US Dollar", code: "USD", symbol: "$"}
faker::finance::currencyName() // "US Dollar"
faker::finance::currencyCode() // "USD"
faker::finance::currencySymbol() // "$"
faker::finance::accountType() // "Savings"
faker::finance::amount() // "720.18"
faker::finance::iban() // "DE89370400440532013000"
faker::finance::bic() // "DEUTDEFF"
faker::finance::accountNumber() // "12345678"
faker::finance::pin() // "1234"
faker::finance::routingNumber() // "123456789"
faker::finance::creditCardNumber() // "4532-1488-0343-6467"
faker::finance::creditCardCvv() // "123"
faker::finance::bitcoinAddress() // "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
faker::finance::litecoinAddress() // "LU2q3eNKx6rmFGp3uCX8EwvY7qhxBn2pLf"
faker::finance::ethereumAddress() // "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"
faker::finance::creditCardExpirationDate() // "03/25"
faker::finance::creditCardType() // "Visa"
faker::food::alcoholicBeverage() // "Beer"
faker::food::grain() // "Rice"
faker::food::milkProduct() // "Cheese"
faker::food::fruit() // "Apple"
faker::food::meat() // "Chicken"
faker::food::seafood() // "Salmon"
faker::food::vegetable() // "Carrot"
faker::food::oil() // "Olive Oil"
faker::food::nut() // "Almond"
faker::food::seed() // "Sunflower Seed"
faker::food::sugarProduct() // "Sugar"
faker::food::nonalcoholicBeverage() // "Coffee"
faker::food::dishName() // "Spaghetti Carbonara"
faker::food::foodCategory() // "Italian"
faker::git::branch() // "feature/add-login"
faker::git::commitDate() // "Mon Nov 12 14:32:49 2018 -0500"
faker::git::commitEntry() // "commit 4e9d8c7... Author: John Doe..."
faker::git::commitMessage() // "Fix bug in login form"
faker::git::commitSha() // "4e9d8c7a6f3b2e1d0c9b8a7f6e5d4c3b2a1"
faker::hacker::abbreviation() // "HTTP"
faker::hacker::adjective() // "cross-platform"
faker::hacker::noun() // "protocol"
faker::hacker::verb() // "parse"
faker::hacker::ingverb() // "parsing"
faker::hacker::phrase() // "Try to parse the HTTP protocol!"
faker::image::imageUrl() // "https://loremflickr.com/640/480"
faker::image::urlLoremFlickr() // "https://loremflickr.com/640/480"
faker::image::urlPicsumPhotos() // "https://picsum.photos/640/480"
faker::image::githubAvatarUrl() // "https://avatars.githubusercontent.com/u/9716558"
faker::image::dimensions() // "1920x1080"
faker::image::type() // "png"
faker::image::dataUri() // "data:image/svg+xml;charset=UTF-8,..."
faker::internet::username() // "Richardson.Jeffrey1997"
faker::internet::email() // "Jimenez.Clyde@gmail.com"
faker::internet::exampleEmail() // "Jimenez.Clyde@example.com"
faker::internet::password() // "gXGpe9pKfFcKy9R"
faker::internet::emoji() // "👑"
faker::internet::checkIfEmojiIsValid("👑") // true
faker::internet::protocol() // "https"
faker::internet::httpMethod() // "POST"
faker::internet::httpStatusCode() // 200
faker::internet::httpRequestHeader() // "Content-Type"
faker::internet::httpResponseHeader() // "Cache-Control"
faker::internet::httpMediaType() // "application/json"
faker::internet::ipv4() // "192.168.1.1"
faker::internet::ipv6() // "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
faker::internet::mac() // "00:1B:44:11:3A:B7"
faker::internet::port() // 8080
faker::internet::url() // "https://example.com"
faker::internet::domainName() // "example.com"
faker::internet::domainSuffix() // "com"
faker::internet::domainWord() // "example"
faker::internet::anonymousUsername(15) // "profusebrother"
faker::internet::jwtToken() // "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
faker::internet::jwtAlgorithm() // "HS256"
faker::location::country() // "United States"
faker::location::continent() // "North America"
faker::location::countryCode() // "US"
faker::location::state() // "California"
faker::location::city() // "Los Angeles"
faker::location::zipCode() // "90210"
faker::location::streetAddress() // "123 Main St"
faker::location::street() // "Main St"
faker::location::buildingNumber() // "123"
faker::location::secondaryAddress() // "Apt. 4"
faker::location::latitude() // "34.052235"
faker::location::longitude() // "-118.243683"
faker::location::nearbyGPSCoordinate() // {"48.8566", "2.3522"}
faker::location::direction() // "North"
faker::location::ordinalDirection() // "Southeast"
faker::location::timeZone() // "America/Los_Angeles"
faker::location::mgrs() // "17SMD92712525"
faker::lorem::word() // "temporibus"
faker::lorem::words() // "qui praesentium pariatur"
faker::lorem::wordVector(3) // {"temporibus", "ipsum", "alias"}
faker::lorem::sentence() // "Laborum voluptatem officiis est et."
faker::lorem::sentences() // "Two sentences here. And another one."
faker::lorem::slug() // "hello-world-test"
faker::lorem::paragraph() // "Long paragraph with multiple sentences..."
faker::lorem::paragraphs() // "Multiple paragraphs..."
faker::medicine::condition() // "Diabetes"
faker::medicine::medicalTest() // "Blood Test"
faker::medicine::specialty() // "Cardiology"
faker::movie::genre() // "Action"
faker::movie::movieTitle() // "The Matrix"
faker::movie::tvShow() // "Breaking Bad"
faker::movie::director() // "Steven Spielberg"
faker::movie::actor() // "Tom Hanks"
faker::movie::actress() // "Meryl Streep"
faker::music::artist() // "The Beatles"
faker::music::songName() // "Yesterday"
faker::music::genre() // "Rock"
faker::number::integer(1, 100) // 42
faker::number::integer(100) // 57 (0 to max)
faker::number::decimal(0.0, 1.0) // 0.573
faker::number::decimal(10.0) // 5.7 (0 to max)
faker::number::normalDistribution(10, 3) // 12.374
faker::number::hexadecimal(8) // "0xae13d044cb"
faker::number::octal(8) // "0o52561721"
faker::number::binary(8) // "0b01110101"
faker::number::binary(0, 1024) // "0b10110" (range)
faker::number::roman(1, 100) // "XLII"
faker::person::firstName() // "Michael"
faker::person::lastName() // "Smith"
faker::person::fullName() // "Michael Smith"
faker::person::prefix() // "Mr."
faker::person::suffix() // "Jr."
faker::person::bio() // "Software engineer passionate about..."
faker::person::sex() // Sex::Male
faker::person::gender() // "Male"
faker::person::jobTitle() // "Software Engineer"
faker::person::jobDescriptor() // "Senior"
faker::person::jobArea() // "IT"
faker::person::jobType() // "Developer"
faker::person::hobby() // "Reading"
faker::person::language() // "English"
faker::person::nationality() // "American"
faker::person::ssn() // "123-45-6789"
faker::person::westernZodiac() // "Aries"
faker::person::chineseZodiac() // "Dragon"
faker::person::passport() // "A12345678"
faker::phone::phoneNumberByFormat() // "961-770-7727"
faker::phone::phoneNumberByFormat("501-###-###") // "501-039-841"
faker::phone::phoneNumberByCountry() // "234-532-654"
faker::phone::platform() // "iOS"
faker::phone::modelName() // "Samsung Galaxy S22"
faker::phone::manufacturer() // "Apple"
faker::phone::imei() // "13-850175-913761-7"
faker::phone::areaCode() // "+1"
faker::plant::tree() // "Oak"
faker::plant::flower() // "Rose"
faker::plant::shrub() // "Azalea"
faker::plant::grass() // "Kentucky Bluegrass"
faker::plant::fern() // "Maidenhair"
faker::plant::succulent() // "Aloe Vera"
faker::plant::vine() // "Ivy"
faker::plant::plantType() // "tree"
faker::science::chemicalElement() // {name: "Hydrogen", symbol: "H", atomicNumber: 1}
faker::science::unit() // {name: "meter", symbol: "m", usedToMeasure: "length"}
faker::science::distanceUnit() // {name: "meter", symbol: "m", usedToMeasure: "length"}
faker::science::timeUnit() // {name: "second", symbol: "s", usedToMeasure: "time"}
faker::science::massUnit() // {name: "gram", symbol: "g", usedToMeasure: "mass"}
faker::science::tempUnit() // {name: "celsius", symbol: "°C", usedToMeasure: "temperature"}
faker::science::currentUnit() // {name: "ampere", symbol: "A", usedToMeasure: "current"}
faker::sport::sportName() // "Football"
faker::sport::soccerTeam() // "Manchester United"
faker::sport::maleAthlete() // "Cristiano Ronaldo"
faker::sport::femaleAthlete() // "Serena Williams"
faker::sport::sportEvent() // "Super Bowl"
faker::string::uuidV1() // "29915d84-c5e8-11ef-9cd2-0242ac120002"
faker::string::uuidV3() // "c6437ef1-5b86-3a4e-a071-c2d4ad414e65"
faker::string::uuidV4() // "78754621-9544-4c79-9c1d-76d3ba881f53"
faker::string::uuidV5("hello") // "6c7f25c1-1f94-53df-aab6-627ed664b1a7"
faker::string::uuidV6() // "1efc5e90-f32e-6420-bab1-7bdb35fa2abb"
faker::string::uuidV7() // "0194129b-f344-783c-ab87-d1a79bcf9a4e"
faker::string::ulid() // "0001C7STHC0G2081040G208104"
faker::string::sample(10) // "Zo!.:*e>wR"
faker::string::symbol(5) // "#$%^&"
faker::string::fromCharacters("abc", 5) // "abcab"
faker::string::alpha(10) // "aBcDeFgHiJ"
faker::string::alphanumeric(10) // "aB3cD5eF7g"
faker::string::numeric(10) // "1234567890"
faker::string::nanoId() // "Hf5lN8L2wQ"
faker::string::nanoId(21) // "V2JlO7GZ1kPl9FxErRqzS"
faker::string::isValidGuarantee(...) // true/false
faker::string::generateAtLeastString(...)// "000aaaaaa"
faker::system::fileName() // "injustice.mpeg"
faker::system::fileExtension() // "pdf"
faker::system::commonFileName() // "dollar.jpg"
faker::system::commonFileExtension() // "gif"
faker::system::mimeType() // "video/vnd.vivo"
faker::system::fileType() // "audio"
faker::system::directoryPath() // "/etc/mail"
faker::system::filePath() // "/usr/local/src/money.dotx"
faker::system::semver() // "1.1.2"
faker::system::networkInterface() // "enp2s7f8"
faker::system::cron() // "22 * ? * ?"
faker::vehicle::bicycle() // "Mountain Bike"
faker::vehicle::color() // "Red"
faker::vehicle::fuel() // "Gasoline"
faker::vehicle::manufacturer() // "Toyota"
faker::vehicle::model() // "Camry"
faker::vehicle::type() // "Sedan"
faker::vehicle::vehicleName() // "Toyota Camry"
faker::vehicle::vin() // "WBADT43452G918366"
faker::vehicle::vrm() // "AB12CDE"
faker::video::formatName() // "MP4"
faker::video::fileExtension() // "mp4"
faker::video::videoCodec() // "H.264"
faker::video::audioCodec() // "AAC"
faker::video::resolution() // "1920x1080"
faker::video::aspectRatio() // "16:9"
faker::video::videoUrl() // "https://youtube.com/watch?v=..."
faker::videogame::gameTitle() // "Minecraft"
faker::videogame::genre() // "Action"
faker::videogame::platform() // "PlayStation 5"
faker::videogame::studioName() // "Mojang Studios"
faker::weather::weatherDescription() // "Partly cloudy"
faker::word::sample() // "protection"
faker::word::sample(5) // "spell"
faker::word::words(3) // "before hourly patiently"
faker::word::adjective() // "complete"
faker::word::adjectiveLocale(5, locale) // "brave" (with locale)
faker::word::adverb() // "deliberately"
faker::word::conjunction() // "because"
faker::word::interjection() // "psst"
faker::word::noun() // "pudding"
faker::word::preposition() // "besides"
faker::word::verb() // "override"
40+ locales supported including:
en_US (default), en_GB, pl_PL, de_DE, de_AT, de_CH, fr_FR, fr_BE, fr_CH, it_IT, es_ES, es_MX, pt_PT, pt_BR, ru_RU, uk_UA, cs_CZ, sk_SK, sv_SE, nb_NO, da_DK, fi_FI, nl_NL, nl_BE, tr_TR, ro_RO, hu_HU, hr_HR, sl_SI, sr_RS, bg_BG, el_GR, hi_IN, en_IN, zh_CN, zh_TW, ja_JP, ko_KR
Usage:
faker::person::firstName(faker::Locale::pl_PL); // "Krystyna"
faker::location::city(faker::Locale::fr_FR); // "Lyon"
-
Add faker to git submodules (execute in project root):
mkdir externals && cd externals git submodule add https://github.com/cieslarmichal/faker-cxx.git git submodule update --init --recursive -
Link with library:
set(FAKER_BUILD_TESTING OFF) add_subdirectory(externals/faker-cxx) add_executable(main Main.cpp) target_link_libraries(main faker-cxx)
set(FAKER_BUILD_TESTING OFF)
FetchContent_Declare(faker
GIT_REPOSITORY https://github.com/cieslarmichal/faker-cxx.git
GIT_TAG main
)
FetchContent_MakeAvailable(faker)
add_executable(main Main.cpp)
target_link_libraries(main faker-cxx)
Installing the library with vcpkg
You can install faker-cxx using the vcpkg dependency manager:
vcpkg install faker-cxx
The faker-cxx port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.
Then in your CMakeLists.txt:
find_package(faker-cxx CONFIG REQUIRED)
add_executable(main Main.cpp)
target_link_libraries(main PRIVATE faker-cxx::faker-cxx)
- MSVC➚ version 143 or newer.
- GCC➚ version 13 or newer.
- Clang➚ version 16 or newer.
- Apple Clang➚ version 16 or newer.
- GTest (set
FAKER_BUILD_TESTING=OFFCMake flag to disable this dependency)
In order to use external dependencies installed in your system, you can set the USE_SYSTEM_DEPENDENCIES CMake flag
to ON.
📦 Building the library with Conan
The library can be built using Conan package manager to solve external dependencies. To build the library with Conan, follow the steps below:
-
Install required dependencies:
conan install conanfile.txt --build=missing -
Build the library:
cmake --preset=conan-release -DUSE_SYSTEM_DEPENDENCIES:BOOL=ON cmake --build --preset=conan-release
Installing the library with Conan
You can install pre-built binaries for faker-cxx or build it from source using Conan. Use the following command:
conan install --requires="faker-cxx/[*]" --build=missing
The faker-cxx Conan recipe is kept up to date by Conan maintainers and community contributors. If the version is out of date, please create an issue or pull request on the ConanCenterIndex repository.
Building the library with Bazel
As alternative, this project can be built using Bazel. The dependencies are managed directly by Bazel modules, downloading and building all external dependencies. Follow the steps below to build the project:
-
Navigate to the project directory:
cd /path/to/faker-cxx -
Build the project:
bazel build //:faker-cxx
We would love it if you contributed to Faker C++! 🚀
Check our guides on how to build the project locally:
- Complete Building Guide - All compilers in one place
Please make sure to read the Contributing Guide before making a pull request.
Additionally, we encourage you to join our Discord Channel for contributors.
Thanks to all the people who already contributed to Faker!
Detailed changes for each release are documented in the release notes.
This project is under MIT license.
