Skip to content

Getting Started

Referência de API (tradução planejada)

A referência completa de API está disponível, por enquanto, em inglês e japonês (tradução futura): - API Reference (English) - API仕様(日本語)

Início | Guia básico | FAQ

Esta página é o caminho principal de onboarding a partir do README do repositório. Ela mostra como instalar argparse-c, executar o primeiro exemplo e escolher o próximo guia.

Pré-requisitos

  • C99 compiler
  • CMake
  • Git

Compilar e instalar

cmake -S . -B build \
  -DCMAKE_C_COMPILER=clang \
  -DCMAKE_CXX_COMPILER=clang++
cmake --build build
cmake --install build --prefix /usr/local

Programa de exemplo

The repository includes sample/example1.c.

Execução de exemplo

./build/sample/example1 -t hello -i 42 input.txt extra.txt

Expected output:

text=hello
integer=42
arg1=input.txt
arg2=extra.txt

Primeiras APIs para aprender

1. Create a parser

ap_parser *parser = ap_parser_new("demo", "demo parser");

2. Define arguments

ap_arg_options opts = ap_arg_options_default();
opts.required = true;
opts.help = "input text";
ap_add_argument(parser, "-t, --text", opts, &err);

3. Parse the command line

ap_parse_args(parser, argc, argv, &ns, &err);

4. Read values from the namespace

const char *text = NULL;
ap_ns_get_string(ns, "text", &text);

Próxima leitura recomendada