Skip to content

docs: add aside concerning ssh aliases when getting unauthenticated errors #1168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: add aside concerning ssh aliases when getting unauthenticated errors #1168

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bc9b0b
docs: add aside concerning ssh aliases when getting unauthenticated e…
letusgitcommit Sep 10, 2025
2771730
add lua tag to code block
letusgitcommit Sep 12, 2025
d940ff5
add section header
letusgitcommit Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,15 @@ GITHUB_TOKEN= gh auth login

`gh` must store the credentials so it can work in a subshell.

**Why am I getting authentication error from gh? Part 2**

It is possible that Octo is trying to authenticate against the origin listed in your repository's config (.git/config) which _could be_ an _ssh alias_ to _github.com_. To properly let octo.nvim know about the ssh alias, you need to list it in the config per above. Example:
```lua
require('octo').setup({
ssh_aliases = {["<THE ALIAS YOU HAVE LISTED IN ~/.ssh/config>"] = "github.com"}
})
```

**Can I use treesitter markdown parser with octo buffers?**

Just add the following lines to your TreeSitter config:
Expand Down