# README
Pulse - AI Empowered Insights
Use AI to get insights from different services. Pulse pull activity from a specified service and use AI to summarize that activity. Add parameters to narrow the scope of the data.
Data Sources
Github
Pulse uses the Github API to pull activity from the ListEventsPerformedByUser endpoint.
Events:
- PushEvent
- PullRequestEvent
These events are parsed and formatted into the content of our summary generation prompt.
Generative AI
OpenAI
Pulse uses the OpenAI API to generate AI insights. CreateChatCompletions is used to generate summaries from the data pulled from the data sources and transcriptions. CreateTranscription is used to convert audio to text to use as a data source.
Pulse CLI
Installation
go install github.com/jesse0michael/pulse/cmd/pulse@latest
Usage
CLI for pulse: AI Empowered Insights
Available Commands:
audio generate a summary of the audio files
github generate a summary of a github user's activity
audio
Usage:
github [file(s)] [flags]
Flags:
-h, --help help for audio
Environment:
OPENAI_URL the url for accessing the OpenAI API
OPENAI_TOKEN the authentication token to use with the OpenAI API
Example
pulse audio example.m4a
Alright, this is Dungeons & Dragons, I am the DM. This is Crystal, the goblin. This is Cedric, Starfall, the elf that is magic. Alright. Previously. Previously on Dungeons & Dragons....
github
Usage:
github [username] [flags]
Flags:
--organization string filter results on an organization
--repository string filter results on a repository
--startDate string filter results after a start date
--endDate string filter results before an end date
-h, --help help for github
Environment:
GITHUB_URL the url for accessing the GitHub API
GITHUB_TOKEN the authentication token to use with the GitHub API
OPENAI_URL the url for accessing the OpenAI API
OPENAI_TOKEN the authentication token to use with the OpenAI API
Example
pulse github jesse0michael
The user "jesse0michael" has been active on multiple repositories on GitHub. Here is a summary of their recent activity:
- Repository: Jesse0Michael/pulse
Pushed commits with the following commit messages:
- Fix: Use correct directory to build CLI
- Chore: Remove debug line
Merged branch 'main' into the repository
- Repository: Jesse0Michael/pulse
Pushed commits with the following commit messages:
- Chore: Add Environment configuration to CLI usage
- Chore: Rename pulse cmd directory
Merged branch 'main' into the repository
- Repository: Jesse0Michael/pulse
- Pushed commits with the following commit messages:
Feat: Update API route to use GitHub and username
CI: Use standard GITHUB_TOKEN
- Repository: Jesse0Michael/pulse
- Pushed commits with the following commit messages:
Fix: Refactor code into Pulser service struct to use in both the CLI and API
Fix: openai service summary output formatting
Fix: Clear default GitHub service URL
Test: Test openai service
- Repository: Jesse0Michael/pulse
- Pushed commits with the following commit messages:
Fix: Make GitHub service testable
- Repository: Jesse0Michael/go-rest-assured
Pushed commits with the following commit messages:
- CI: Release from main
- Chore: Change default branch to main
- Build: Move docker labels
- Feat: BREAKING CHANGE upgrade rest assured to v4
- Feat: Export Serve method to start HTTP listener
- Remove client context and error channel
- Rely on the caller of the package to appropriately call Serve
- Chore: Upgrade to Go 1.21
- Feat: Move to log/slog for logging
- Fix: Use google/uuid package
- Test: Serve rest assured client in tests
- Chore: Update license
- Feat: Add NewClientServe function
- Build: Add docker labels
- CI: Update Go version
Opened a pull request in the repository with the title "feat: BREAKING CHANGE upgrade rest assured to v4" and a description containing links to related commits.
- Repository: Jesse0Michael/fetcher
- Pushed commits with the following commit message:
- Fix: Disable Instagram feed