Skip to content

🔑 AddGitHubToken

向 Composer 的 auth.json 中添加 GitHub OAuth 令牌,用于访问私有仓库或提升 API 速率限制。

何时使用

当你的项目依赖托管在 GitHub 的私有 Composer 仓库,或需要以认证身份拉取 GitHub 资源时使用。令牌会写入 Composer 主目录下的 auth.json

签名

go
func (c *Composer) AddGitHubToken(domain string, token string) error

参数

参数类型说明
domainstring令牌适用的域名,通常为 github.com
tokenstringGitHub 个人访问令牌(PAT)

返回值

error:读取或写入 auth.json 失败时返回相应错误信息,成功时为 nil

示例

go
package main

import (
	"fmt"
	"log"

	"github.com/scagogogo/composer-skills/pkg/composer"
)

func main() {
	comp, err := composer.New(composer.DefaultOptions())
	if err != nil {
		log.Fatalf("初始化失败: %v", err)
	}

	// 添加 GitHub 令牌
	if err := comp.AddGitHubToken("github.com", "ghp_xxxxxxxxxxxxxxxxxxxx"); err != nil {
		log.Fatalf("添加令牌失败: %v", err)
	}

	fmt.Println("GitHub 令牌已写入 auth.json")
}

进阶

基于 MIT 许可证发布