#git-history #generate #config-file #llm #story #git-utility #gitory

app gitory-cli

Build a story for your project based on your git history

1 unstable release

0.1.0 May 1, 2024

#10 in #story

Custom license

29KB
643 lines

gitory-cli

Usage

  • make sure have the following env variables set before running the script:

    $ export MODEL_NAME=
    $ export API_ENDPOINT=
    $ export API_KEY=
    
  • now make sure you have the gitory_config.toml file in the root of the project for which you plan to use gitory. Sample config file is provided

    gitory_config.toml

    [app]
    max_commit_depth = 2
    output_dir = "gitory"
    
    [llm]
    provider = "google_gemini"
    
    [llm.api_config]
    model = "MODEL_NAME"
    endpoint = "API_ENDPOINT"
    key = "API_KEY"
    
    [llm.generation_config]
    temperature = 0.35
    top_p = 0.8
    top_k = 40
    

You are now all set to use gitory.

$ gitory-cli generate

Dependencies

~15–28MB
~495K SLoC