Skip to content
ochat
Search documentation

Use quotes for an exact phrase.

Search by topic, command, or code identifier.

    GitHub ↗

    Applications

    Generate a project report from a script

    Run one request without the terminal UI and save the conversation as an inspectable artifact.

    View Markdown source ↗
    ← All applications

    InputA project status note

    OutputA saved ChatMD report

    Setup Installed Ochat, a configured provider with access to gpt-4.1 (or an edited supported model), and launch from the extracted directory. Model requests incur provider charges.

    Inspect the agent files →Run a request from a script →
    Workflow overview · illustrative
    1. Read the status note
    2. Summarize blockers
    3. Save the conversation

    Run one request without the terminal UI and save the conversation as an inspectable artifact.

    Use the same file-based authoring model from a shell script or CI job, with a fresh transcript for each independent run.

    The outcome

    Section titled “The outcome”

    Input: A project status note.

    Output: A saved ChatMD report.

    Produce a saved report

    Section titled “Produce a saved report”

    Complete installation and provider setup, extract the headless-report bundle, and run from its directory:

    Terminal window
    mkdir -p runs
    ochat chat-completion -prompt-file agent.chatmd -output-file runs/report-01.chatmd

    agent.chatmd includes a request to summarize the fictional Lantern status note. Open runs/report-01.chatmd to inspect the conversation and report. Expect Completed, Blocked, and Next steps sections grounded in reference/status.txt. The preview is an illustration; no provider-generated result is implied.

    Put it in a script or CI job

    Section titled “Put it in a script or CI job”

    Install Ochat and configure the provider environment in the runner. Supply the input files, set the working directory to the extracted example, and choose a fresh output path for each independent invocation. Do not reuse an existing transcript unless you intend the batch resume behavior. Keep credentials in the runner’s secret configuration and publish transcripts only when their contents are suitable for the intended audience.

    Adapt the artifact

    Section titled “Adapt the artifact”

    Use the prompt for release-readiness notes, a documentation checklist, or a summary of supplied test results. The saved output is ChatMD, not a standalone HTML report or an automatic success/failure gate. Define and validate any machine-consumed report contract before using it to control a pipeline.

    Explore another application or follow the tutorial curriculum.

    View source · Headless project report3 files

    Complete source files. Open a filename to read it here.

    agent.chatmdStart here
    <config model="gpt-4.1" max_tokens="1200"/>
<tool name="read_file">
  <read id="reference" path="${workspace}/reference" description="Included example input files"/>
</tool>
<developer>Read status.txt from the reference root. Write a project report with Completed, Blocked, and Next steps sections. Cite status.txt. Do not invent dates, owners, or completed work. You have no shell or editing tools.</developer>
<user>Prepare the current Lantern project report.</user>

    Link to this fileDownload this file

    reference/status.txtdata
    Lantern weekly status (fictional sample)
Completed: documentation structure and initial overview.
Blocked: setup instructions need confirmed build commands.
Next: a maintainer should verify those commands and write the contributor checklist.
No release date has been chosen.

    Link to this fileDownload this file

    LICENSE.txtnotice
    MIT License

Copyright (c) 2025 

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

    Link to this fileDownload this file