Liking cljdoc? Tell your friends :D

Point out your outdated dependencies.

GitHub Actions for test workflow GitHub Actions for lint workflow GitHub Actions for dependencies workflow codecov

Clojars Project Docker Hub

Note

Antq requires Clojure 1.8.0 or later. (However --upgrade option requires Clojure 1.9.0 or later)
If you’d like to use with 1.7.0 or earlier, please see here.

Supported files

Usage

Clojure CLI Tool

Run the following command for trial.

clojure -Sdeps '{:deps {antq/antq {:mvn/version "RELEASE"}}}' -m antq.core

Or add the following alias to your $HOME/.clojure/deps.edn.

{
 :aliases
 {:outdated {:extra-deps {antq/antq {:mvn/version "RELEASE"}}
             :main-opts ["-m" "antq.core"]}}
 }

Then, run clojure -M:outdated. (run clojure -A:outdated for Clojure CLI Tool 1.10.1.645 or earlier).

Leiningen

Add the following dependency and alias to your $HOME/.lein/profiles.clj.

{
 :user
 {:dependencies [[antq/antq "RELEASE"]]
  :aliases {"outdated" ["run" "-m" "antq.core"]}
  }
 }

Then, run lein outdated.

GitHub Actions

Antq can work with GitHub Actions. See antq’s workflow for concrete example.

In another way, you can use the following action.

Options

--upgrade

Upgrade outdated versions interactively. You can use --force option for upgrading without confirmation.

Warning

For now, --upgrade option only supports following files.

  • deps.edn

  • shadow-cljs.edn

  • project.clj

  • build.boot

  • pom.xml

--exclude=ARTIFACT_NAME

Skip version checking for specified artifacts.

E.g. --exclude=antq/antq

Note
You must specify groupId/artifactId for Java dependencies.

--directory=DIRECTORY

Add search path for projects. Current directory(.) is added by default.

E.g. -d foo --directory=bar:baz will search "foo", "baz" and "bar" directories.

--focus=ARTIFACT_NAME

Focus version checking for specified artifacts.

E.g. --focus=antq/antq

Note
You must specify groupId/artifactId for Java dependencies.
Warning
focus option is prefer than exclude option.

--skip=PROJECT_TYPE

Skip to search specified project files. Must be one of boot, clojure-cli, github-action, pom, shadow-cljs and leiningen.

E.g. --skip=pom

--error-format=ERROR_FORMAT

Customize outputs for outdated dependencies.

E.g. --error-format="::error file={{file}}::{{message}}"

You can use following variables:

Variable Name Description

{{file}}

A filename containing outdated dependencies.

{{name}}

The artifact name.

{{version}}

The current version.

{{latest-version}}

The latest version.

{{diff-url}}

The diff URL for Version Control System. (Nullable)

{{message}}

Default error message.

--reporter=REPORTER

Reporter Name Description

table (default)

Report results in a table.

format

Report results with a custom format. When you use --error-format option, this reporter will be used automatically.

json

Report results as a JSON format.

edn

Report results as a EDN format.

License

Copyright © 2020-2021 Masashi Iizuka

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

Can you improve this documentation? These fine people already did:
liquidz & Travis Jefferson
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close