@nanocollective/nanocoder 1.14.2 → 1.14.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +79 -5
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -8,7 +8,7 @@ A local-first CLI coding agent that brings the power of agentic coding tools lik
8
8
 
9
9
  - [FAQs](#faqs)
10
10
  - [Installation](#installation)
11
- - [For Users (Recommended)](#for-users-recommended)
11
+ - [For Users](#for-users)
12
12
  - [For Development](#for-development)
13
13
  - [Configuration](#configuration)
14
14
  - [AI Provider Setup](#ai-provider-setup)
@@ -45,7 +45,9 @@ Firstly, we would love for you to be involved. You can get started contributing
45
45
 
46
46
  ## Installation
47
47
 
48
- ### For Users (Recommended)
48
+ ### For Users
49
+
50
+ #### NPM (Recommended)
49
51
 
50
52
  Install globally and use anywhere:
51
53
 
@@ -59,6 +61,39 @@ Then run in any directory:
59
61
  nanocoder
60
62
  ```
61
63
 
64
+ #### Nix Flakes
65
+
66
+ Run Nanocoder directly using:
67
+
68
+ ```bash
69
+ # If you have flakes enabled in your Nix config:
70
+ nix run github:Nano-Collective/nanocoder
71
+
72
+ # If you don't have flakes enabled:
73
+ nix run --extra-experimental-features 'nix-command flakes' github:Nano-Collective/nanocoder
74
+ ```
75
+
76
+ Or install from `packages` output:
77
+
78
+ ```nix
79
+ # flake.nix
80
+ {
81
+ inputs = {
82
+ nanocoder = {
83
+ url = "github:Nano-Collective/nanocoder";
84
+ inputs.nixpkgs.follows = "nixpkgs";
85
+ };
86
+ };
87
+ }
88
+
89
+ # configuration.nix
90
+ { pkgs, inputs, system, ... }: {
91
+ environment.systemPackages = [
92
+ inputs.nanocoder.packages."${system}".default
93
+ ];
94
+ }
95
+ ```
96
+
62
97
  ### For Development
63
98
 
64
99
  If you want to contribute or modify Nanocoder:
@@ -100,7 +135,35 @@ npm run dev
100
135
 
101
136
  ### AI Provider Setup
102
137
 
103
- Nanocoder supports any OpenAI-compatible API through a unified provider configuration. Create `agents.config.json` in your **working directory** (where you run `nanocoder`):
138
+ Nanocoder supports any OpenAI-compatible API through a unified provider configuration.
139
+
140
+ **Configuration Methods:**
141
+
142
+ 1. **Interactive Setup (Recommended for new users)**: Run `/setup-config` inside Nanocoder for a guided wizard with provider templates
143
+ 2. **Manual Configuration**: Create an `agents.config.json` file (see below for locations)
144
+
145
+ **Configuration File Locations:**
146
+
147
+ Nanocoder looks for configuration in the following order (first found wins):
148
+
149
+ 1. **Project-level** (highest priority): `agents.config.json` in your current working directory
150
+
151
+ - Use this for project-specific providers, models, or API keys
152
+ - Perfect for team sharing or repository-specific configurations
153
+
154
+ 2. **User-level (preferred)**: Platform-specific application data directory
155
+
156
+ - **macOS**: `~/Library/Preferences/nanocoder/agents.config.json`
157
+ - **Linux/Unix**: `~/.config/nanocoder/agents.config.json`
158
+ - **Windows**: `%APPDATA%\nanocoder\agents.config.json`
159
+ - Your global default configuration
160
+ - Used when no project-level config exists
161
+
162
+ 3. **User-level (legacy)**: `~/.agents.config.json`
163
+ - Supported for backward compatibility
164
+ - Recommended to migrate to platform-specific location above
165
+
166
+ **Example Configuration** (`agents.config.json`):
104
167
 
105
168
  ```json
106
169
  {
@@ -277,11 +340,22 @@ Popular MCP servers:
277
340
  - **Memory**: Persistent context storage
278
341
  - [View more MCP servers](https://github.com/modelcontextprotocol/servers)
279
342
 
280
- > **Note**: The default save place for configuration is `~/config/nanocoder/`. You can also place an `agents.config.json` where you run Nanocoder. This will **override** the default for project-by-project configuration with different models or API keys per repository.
343
+ > **Note**: MCP server configuration follows the same location hierarchy as AI provider setup above. Use `/setup-config` for an interactive configuration wizard, or manually edit `agents.config.json` at the project level (current directory) or user level (platform-specific paths listed above).
281
344
 
282
345
  ### User Preferences
283
346
 
284
- Nanocoder automatically saves your preferences to remember your choices across sessions. Preferences are stored in `~/config/nanocoder/nanocoder-preferences.json`. You can also place a `nanocoder-preferences.json` where you run Nanocoder. This will **override** the default for project-by-project configuration.
347
+ Nanocoder automatically saves your preferences to remember your choices across sessions.
348
+
349
+ **Preferences File Locations:**
350
+
351
+ Preferences follow the same location hierarchy as configuration files:
352
+
353
+ 1. **Project-level**: `nanocoder-preferences.json` in your current working directory (overrides user-level)
354
+ 2. **User-level**: Platform-specific application data directory:
355
+ - **macOS**: `~/Library/Preferences/nanocoder/nanocoder-preferences.json`
356
+ - **Linux/Unix**: `~/.config/nanocoder/nanocoder-preferences.json`
357
+ - **Windows**: `%APPDATA%\nanocoder\nanocoder-preferences.json`
358
+ 3. **Legacy**: `~/.nanocoder-preferences.json` (backward compatibility)
285
359
 
286
360
  **What gets saved automatically:**
287
361
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@nanocollective/nanocoder",
3
3
  "main": "dist/cli.js",
4
- "version": "1.14.2",
4
+ "version": "1.14.3",
5
5
  "description": "A local-first CLI coding agent that brings the power of agentic coding tools like Claude Code and Gemini CLI to local models or controlled APIs like OpenRouter",
6
6
  "keywords": [
7
7
  "cli",
@@ -54,7 +54,7 @@
54
54
  "@langchain/openai": "^0.6.15",
55
55
  "@mishieck/ink-titled-box": "^0.3.0",
56
56
  "@modelcontextprotocol/sdk": "^1.17.3",
57
- "@nanocollective/get-md": "^1.0.0",
57
+ "@nanocollective/get-md": "^1.0.1",
58
58
  "cheerio": "^1.1.2",
59
59
  "cli-highlight": "^2.1.11",
60
60
  "dotenv": "^17.2.3",