Skip to content

docs: update akka cli installation instructions - #1194

Merged
olofwalker merged 6 commits into
mainfrom
akka-cli-install-docs
Feb 9, 2026
Merged

olofwalker merged 6 commits into
mainfrom
akka-cli-install-docs

Conversation

@janikdotzel

Copy link
Copy Markdown
Contributor

This documentation is related to
Issue: https://github.com/lightbend/kalix/issues/10858
PR: https://github.com/akka/cli/pull/22

Windows

I kept the download-zip approach underneath. Maybe not every windows user uses a package manager.

Before:
image
After:
image

Linux

I kept the curl-script approach. If there are problems with the Cloudsmith repo we have a fallback scenario.
But it makes the instruction kinda long.

Before:
image
After:
image

WDYT?

@janikdotzel janikdotzel self-assigned this Dec 9, 2025
@github-actions github-actions Bot added the documentation documentation related label Dec 9, 2025
Co-authored-by: olofwalker <23613882+olofwalker@users.noreply.github.com>
----

**Alternative approach**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also have this quick install page, which is linked to from getting started and such
https://doc.akka.io/getting-started/quick-install-cli.html

Does that also need update of the recommended approach?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!
I'll update this page as well.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated d0a0701

@patriknw patriknw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but I think we could improve the link names

....
----
curl -1sLf \
'https://dl.cloudsmith.io/public/lightbend/public-akka/setup.deb.sh' \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@olofwalker Shouldn't we have a more public facing dns name for these downloads? lightbend is obsolete naming and cloudsmith is something internal that shouldn't be shown, in my opinion

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can work with @sebastian-alfers to get a proxy redirect in place

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, which url should it be? I think it should start with repo.akka.io

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

repo sounds good, but the term might be semantically overloaded.
I would throw cli.akka.io into the room.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe so. This is currently the download link for windows https://downloads.akka.io/latest/akka_windows_amd64.zip.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should use downloads.akka.io then

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sebastian-alfers Have we set up the forwarding yet?

@sebastian-alfers sebastian-alfers Jan 15, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I now manually uploaded it to https://downloads.akka.io/setup.deb.sh.

For the record, this is the kalix-storage project in gcp and the bucket is kalix-binaries.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the link in both places abbbc40

@aludwiko aludwiko left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@janikdotzel

Copy link
Copy Markdown
Contributor Author

@olofwalker Do you know when the next akka-cli release will be made?
This are the docs for https://github.com/akka/cli/pull/37 and https://github.com/akka/cli/pull/22 and I'm currently leaving this open until the CLI changes are released.

@olofwalker

Copy link
Copy Markdown
Contributor

@janikdotzel We just released the CLI yeasterday

@janikdotzel

janikdotzel commented Jan 23, 2026 •

Copy link
Copy Markdown
Contributor Author

@olofwalker
The winget-publish script failed during the release and swallowed the error.
I've added a PR to make it more verbose.
Can we eventually create a release after that PR to have faster progress?

@janikdotzel

Copy link
Copy Markdown
Contributor Author

@olofwalker
I reflected the package rename in the docs.
I'd wait with the merge of this PR until the CLI has a new release, unless you say otherwise.

@JustinPihony

Copy link
Copy Markdown
Contributor

I believe there was a new release. Can this go out now?

@olofwalker
olofwalker merged commit 8bc7c82 into main Feb 9, 2026
10 checks passed
@olofwalker
olofwalker deleted the akka-cli-install-docs branch February 9, 2026 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants