gitory-cli

Crates.iogitory-cli
lib.rsgitory-cli
version0.1.0
created_at2024-05-01 21:18:18.880601+00
updated_at2024-05-01 21:18:18.880601+00
descriptionBuild a story for your project based on your git history
homepage
repositoryhttps://github.com/Dexter2389/gitory
max_upload_size
id1227164
size69,892
Saurabh Ghanekar (Dexter2389)

documentation

README

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
Commit count: 0

cargo fmt