Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 4.76 KB

README.md

File metadata and controls

66 lines (48 loc) · 4.76 KB

Freshli Logo

Freshli

Freshli is a tool for collecting historical metrics about a project's dependencies. View graphs about how your projects' dependency freshness has changed over time.

You can use Freshli in a number of ways:

Type Description
Homepage Freshli marketing website
Website UI Website that displays analysis reports. Provides a publication API to the CLI application. This is a closed-source project, and access to reports will eventually be monetized.
Freshli API Targeted for initial release with version 0.7.0, this will be the API that both Freshli UI and Freshli CLI use. This is a closed-source project, and access will be limited to users with Freshli UI accounts.
Command Line (CLI) Analyze a local project. Results are viewable via the Website App.
Command Line Java Language Agent Language-specific agent program that knows how to process dependencies from the Java ecosystem
Command Line DotNet Language Agent (in progress) Language-specific agent program that knows how to process dependencies from the .NET ecosystem
Command Line Python Language Agent (in progress) Language-specific agent program that knows how to process dependencies from the Python ecosystem
Command Line Go Language Agent (in progress) Language-specific agent program that knows how to process dependencies from the Go ecosystem

Roadmap

You can view the GitHub project to see the work that we have planned. The "Roadmap" tab shows the milestones we've assigned each Epic to. We've elected to use the same version numbers across all of the Freshli projects to help communicate which work will be completed simultaneously. We're currently working on releasing version 0.6.0.

Related Projects

The following libraries support the functionality of either the CLI, a language agent, or the website.

Name Description
Freshli Commons A small Ruby Gem containing common code used by build scripts and Cucumber/Aruba tests in most Freshli repositories
Dependency History Maven A Java library that knows how to determine a package's release history using the information in Maven. Used by freshli-agent-java and the fork of the Versions Maven Plugin.
Versions Maven Plugin (fork) A fork of the Maven Versions Plugin that adds a Maven goal that can be run to resolve version ranges to a specific version number that was available on a particular date. This is required to collect historical data correctly.

Questions? Spot a Bug?

If you have any general questions about Freshli or spot an issue with the Freshli UI, API, or marketing website, please open an issue.

If you have questions about an Open Source Freshli project, please enter them in the appropriate repository. We are also accepting pull requests for these projects.

Freshli CLI

Java Language Agent

DotNet Language Agent

Python Language Agent

Go Language Agent

freshli-commons Ruby Gem

Dependency History Maven